isaacscript-common 6.2.0 → 6.4.0

package/features/pause.lua

@@ -0,0 +1,71 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local postUpdate, inputActionGetActionValue, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ButtonAction = ____isaac_2Dtypescript_2Ddefinitions.ButtonAction
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local InputHook = ____isaac_2Dtypescript_2Ddefinitions.InputHook
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____log = require("functions.log")
+local logError = ____log.logError
+local ____player = require("functions.player")
+local useActiveItemTemp = ____player.useActiveItemTemp
+local ____disableInputs = require("features.disableInputs")
+local disableAllInputsExceptFor = ____disableInputs.disableAllInputsExceptFor
+local enableAllInputs = ____disableInputs.enableAllInputs
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postUpdate(self)
+    if not v.run.isPseudoPaused then
+        return
+    end
+    local player = Isaac.GetPlayer()
+    useActiveItemTemp(nil, player, CollectibleType.PAUSE)
+end
+function inputActionGetActionValue(self, _entity, _inputHook, buttonAction)
+    if buttonAction ~= ButtonAction.SHOOT_RIGHT then
+        return
+    end
+    if not v.run.shouldUnpause then
+        return
+    end
+    v.run.shouldUnpause = false
+    return 1
+end
+local FEATURE_NAME = "pause"
+v = {run = {isPseudoPaused = false, shouldUnpause = false}}
+---
+-- @internal
+function ____exports.pauseInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
+    mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
+    mod:AddCallback(ModCallback.INPUT_ACTION, inputActionGetActionValue, InputHook.GET_ACTION_VALUE)
+end
+--- Helper function to emulate what happens when the player pauses the game. Use the `unpause`
+-- function to return things back to normal.
+-- 
+-- Under the hood, this function:
+-- - uses the Pause collectible on every game frame
+-- - disables any player inputs (except for `ButtonAction.MENU_CONFIRM`)
+function ____exports.pause(self)
+    if v.run.isPseudoPaused then
+        logError("Failed to pseudo-pause the game, since it was already pseudo-paused.")
+        return
+    end
+    v.run.isPseudoPaused = true
+    local whitelist = __TS__New(Set, {ButtonAction.MENU_CONFIRM})
+    disableAllInputsExceptFor(nil, FEATURE_NAME, whitelist)
+end
+--- Helper function to put things back to normal after the `pause` function was used.
+function ____exports.unpause(self)
+    if not v.run.isPseudoPaused then
+        logError("Failed to pseudo-unpause the game, since it was not already pseudo-paused.")
+        return
+    end
+    v.run.isPseudoPaused = false
+    enableAllInputs(nil, FEATURE_NAME)
+    v.run.shouldUnpause = true
+end
+return ____exports

package/features/runNextRoom.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Supply a function to run on the next `POST_NEW_ROOM` callback.
+ *
+ * Note that this function will not handle saving and quitting. If a player saving and quitting
+ * before the deferred function fires would cause a bug in your mod, then you should handle deferred
+ * functions manually using serializable data.
+ */
+export declare function runNextRoom(func: () => void): void;

package/features/runNextRoom.lua

@@ -0,0 +1,40 @@
+local ____exports = {}
+local postNewRoomReordered, v
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____array = require("functions.array")
+local emptyArray = ____array.emptyArray
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postNewRoomReordered(self)
+    for ____, func in ipairs(v.run.queuedFunctions) do
+        func(nil)
+    end
+    emptyArray(nil, v.run.queuedFunctions)
+end
+local FEATURE_NAME = "runNextRoom"
+v = {run = {queuedFunctions = {}}}
+---
+-- @internal
+function ____exports.runNextRoomInit(self, mod)
+    saveDataManager(
+        nil,
+        FEATURE_NAME,
+        v,
+        function() return false end
+    )
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
+end
+--- Supply a function to run on the next `POST_NEW_ROOM` callback.
+-- 
+-- Note that this function will not handle saving and quitting. If a player saving and quitting
+-- before the deferred function fires would cause a bug in your mod, then you should handle deferred
+-- functions manually using serializable data.
+function ____exports.runNextRoom(self, func)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local ____v_run_queuedFunctions_0 = v.run.queuedFunctions
+    ____v_run_queuedFunctions_0[#____v_run_queuedFunctions_0 + 1] = func
+end
+return ____exports

package/features/saveDataManager/exports.lua

@@ -11,8 +11,6 @@ local ____deepCopy = require("functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
 local ____types = require("functions.types")
 local isString = ____types.isString
-local ____constants = require("features.saveDataManager.constants")
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
 local ____main = require("features.saveDataManager.main")
 local forceSaveDataManagerLoad = ____main.forceSaveDataManagerLoad
 local forceSaveDataManagerSave = ____main.forceSaveDataManagerSave
@@ -21,6 +19,8 @@ local ____maps = require("features.saveDataManager.maps")
 local saveDataConditionalFuncMap = ____maps.saveDataConditionalFuncMap
 local saveDataDefaultsMap = ____maps.saveDataDefaultsMap
 local saveDataMap = ____maps.saveDataMap
+local ____saveDataManagerConstants = require("features.saveDataManager.saveDataManagerConstants")
+local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
 --- This is the entry point to the save data manager, a system which provides two major features:
 -- 
 -- 1. automatic resetting of variables on a new run, on a new level, or on a new room (as desired)

package/features/saveDataManager/load.lua

@@ -12,11 +12,11 @@ local iterateTableInOrder = ____table.iterateTableInOrder
 local ____types = require("functions.types")
 local isString = ____types.isString
 local isTable = ____types.isTable
-local ____constants = require("features.saveDataManager.constants")
-local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
 local ____merge = require("features.saveDataManager.merge")
 local merge = ____merge.merge
+local ____saveDataManagerConstants = require("features.saveDataManager.saveDataManagerConstants")
+local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
+local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
 function readSaveDatFile(self, mod)
     local renderFrameCount = Isaac.GetFrameCount()
     local ok, jsonStringOrErrMsg = pcall(tryLoadModData, mod)

package/features/saveDataManager/main.lua

@@ -21,9 +21,6 @@ local logError = ____log.logError
 local ____table = require("functions.table")
 local clearTable = ____table.clearTable
 local iterateTableInOrder = ____table.iterateTableInOrder
-local ____constants = require("features.saveDataManager.constants")
-local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
 local ____load = require("features.saveDataManager.load")
 local loadFromDisk = ____load.loadFromDisk
 local ____maps = require("features.saveDataManager.maps")
@@ -32,6 +29,9 @@ local saveDataDefaultsMap = ____maps.saveDataDefaultsMap
 local saveDataMap = ____maps.saveDataMap
 local ____save = require("features.saveDataManager.save")
 local saveToDisk = ____save.saveToDisk
+local ____saveDataManagerConstants = require("features.saveDataManager.saveDataManagerConstants")
+local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
+local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
 function postPlayerInit(self)
     if mod == nil then
         error(("The mod for the " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " was not initialized.")

package/features/saveDataManager/merge.lua

@@ -26,8 +26,8 @@ local ____types = require("functions.types")
 local isTable = ____types.isTable
 local ____utils = require("functions.utils")
 local getTraversalDescription = ____utils.getTraversalDescription
-local ____constants = require("features.saveDataManager.constants")
-local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
+local ____saveDataManagerConstants = require("features.saveDataManager.saveDataManagerConstants")
+local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
 local ____serializationBrand = require("features.saveDataManager.serializationBrand")
 local isSerializationBrand = ____serializationBrand.isSerializationBrand
 --- `merge` takes the values from a new table and recursively merges them into an old object (while

package/features/saveDataManager/save.lua

@@ -13,9 +13,9 @@ local ____log = require("functions.log")
 local log = ____log.log
 local ____table = require("functions.table")
 local iterateTableInOrder = ____table.iterateTableInOrder
-local ____constants = require("features.saveDataManager.constants")
-local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
+local ____saveDataManagerConstants = require("features.saveDataManager.saveDataManagerConstants")
+local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
+local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
 function getAllSaveDataToWriteToDisk(self, saveDataMap, saveDataConditionalFuncMap)
     local allSaveData = {}
     iterateTableInOrder(

package/functions/chargeBar.lua

@@ -1,7 +1,5 @@
 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
@@ -37,11 +35,11 @@ end
 --- Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
 -- function to initialize the sprites, and then call this function on every render frame.
 function ____exports.renderChargeBar(self, sprites, position, normalCharges, batteryCharges)
-    sprites.back:Render(position, VectorZero, VectorZero)
+    sprites.back:Render(position)
     local normalChargesClamp = getChargeBarClamp(nil, normalCharges, sprites.maxCharges)
-    sprites.meter:Render(position, normalChargesClamp, VectorZero)
+    sprites.meter:Render(position, normalChargesClamp)
     local batteryChargesClamp = getChargeBarClamp(nil, batteryCharges, sprites.maxCharges)
-    sprites.meterBattery:Render(position, batteryChargesClamp, VectorZero)
-    sprites.lines:Render(position, VectorZero, VectorZero)
+    sprites.meterBattery:Render(position, batteryChargesClamp)
+    sprites.lines:Render(position)
 end
 return ____exports

package/functions/color.d.ts

@@ -19,8 +19,6 @@ export declare function colorEquals(color1: Color, color2: Color): boolean;
  */
 export declare function copyColor<C extends Color | SerializedColor, S extends SerializationType>(color: C, serializationType: S): CopyColorReturn[S];
 export declare function copyColor<C extends Color | SerializedColor>(color: C): CopyColorReturn[SerializationType.NONE];
-/** Returns `Color(1, 1, 1)`. */
-export declare function getDefaultColor(): Color;
 /** Helper function to check if something is an instantiated Color object. */
 export declare function isColor(object: unknown): object is Color;
 /**

package/functions/color.lua

@@ -104,10 +104,6 @@ function ____exports.copyColor(self, color, serializationType)
         end
     until true
 end
---- Returns `Color(1, 1, 1)`.
-function ____exports.getDefaultColor(self)
-    return Color(1, 1, 1)
-end
 --- Used to determine is the given table is a serialized `Color` object created by the save data
 -- manager and/or the `deepCopy` function.
 function ____exports.isSerializedColor(self, object)

package/functions/deepCopy.lua

@@ -15,8 +15,8 @@ local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
-local ____constants = require("features.saveDataManager.constants")
-local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
+local ____saveDataManagerConstants = require("features.saveDataManager.saveDataManagerConstants")
+local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
 local ____serializationBrand = require("features.saveDataManager.serializationBrand")
 local isSerializationBrand = ____serializationBrand.isSerializationBrand
 local ____array = require("functions.array")

package/functions/direction.d.ts

@@ -8,5 +8,5 @@ import { Direction } from "isaac-typescript-definitions";
  */
 export declare function angleToDirection(angleDegrees: int): Direction;
 export declare function directionToDegrees(direction: Direction): int;
-export declare function directionToVector(direction: Direction): Vector;
+export declare function directionToVector(direction: Direction): Readonly<Vector>;
 export declare function getDirectionName(direction: Direction): string | undefined;

package/functions/doors.d.ts

@@ -22,7 +22,7 @@ export declare function getDevilRoomOrAngelRoomDoor(): GridEntityDoor | undefine
  * they would immediately collide with the loading zone. Instead, they are offset by a certain
  * amount of units.
  */
-export declare function getDoorEnterPosition(door: GridEntityDoor): Vector;
+export declare function getDoorEnterPosition(door: GridEntityDoor): Readonly<Vector>;
 /**
  * Helper function to get the offset from a door position that a player will enter a room at.
  *
@@ -30,7 +30,7 @@ export declare function getDoorEnterPosition(door: GridEntityDoor): Vector;
  * they would immediately collide with the loading zone. Instead, they are offset by a certain
  * amount of units.
  */
-export declare function getDoorSlotEnterPositionOffset(doorSlot: DoorSlot): Vector;
+export declare function getDoorSlotEnterPositionOffset(doorSlot: DoorSlot): Readonly<Vector>;
 /**
  * Helper function to convert an array of door slots or a set of door slots to the resulting bit
  * flag number.

package/functions/entity.d.ts

@@ -72,6 +72,11 @@ export declare function getEntities(entityType?: EntityType, variant?: number, s
 export declare function getEntityFields(entity: Entity): LuaTable<string, boolean | number | string>;
 /** Helper function to return a string containing the entity's type, variant, and sub-type. */
 export declare function getEntityID(entity: Entity): string;
+/**
+ * Helper function to return a formatted string in the format returned by the `getEntityID`
+ * function.
+ */
+export declare function getEntityIDFromConstituents(entityType: EntityType, variant: int, subType: int): string;
 /**
  * Helper function to compare two different arrays of entities. Returns the entities that are in the
  * second array but not in the first array.

package/functions/entity.lua

@@ -202,6 +202,11 @@ end
 function ____exports.getEntityID(self, entity)
     return (((tostring(entity.Type) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType)
 end
+--- Helper function to return a formatted string in the format returned by the `getEntityID`
+-- function.
+function ____exports.getEntityIDFromConstituents(self, entityType, variant, subType)
+    return (((tostring(entityType) .. ".") .. tostring(variant)) .. ".") .. tostring(subType)
+end
 --- Helper function to compare two different arrays of entities. Returns the entities that are in the
 -- second array but not in the first array.
 function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
@@ -349,6 +354,14 @@ function ____exports.spawn(self, entityType, variant, subType, position, velocit
     if seedOrRNG == nil then
         seedOrRNG = nil
     end
+    if position == nil then
+        local entityID = ____exports.getEntityIDFromConstituents(nil, entityType, variant, subType)
+        error(("Failed to spawn entity " .. entityID) .. " since an undefined position was passed to the \"spawn\" function.")
+    end
+    if velocity == nil then
+        local entityID = ____exports.getEntityIDFromConstituents(nil, entityType, variant, subType)
+        error(("Failed to spawn entity " .. entityID) .. " since an undefined velocity was passed to the \"spawn\" function.")
+    end
     if seedOrRNG == nil then
         return Isaac.Spawn(
             entityType,

package/functions/gridEntity.d.ts

@@ -61,6 +61,11 @@ export declare function getGridEntitiesExcept(...gridEntityTypes: GridEntityType
 export declare function getGridEntitiesMap(...gridEntityTypes: GridEntityType[]): Map<int, GridEntity>;
 /** Helper function to return a string containing the grid entity's type and variant. */
 export declare function getGridEntityID(gridEntity: GridEntity): string;
+/**
+ * Helper function to return a formatted string in the format returned by the `getGridEntityID`
+ * function.
+ */
+export declare function getGridEntityIDFromConstituents(gridEntityType: GridEntityType, variant: int): string;
 /**
  * Helper function to get all of the grid entities in the room that specifically match the type and
  * variant provided.

package/functions/gridEntity.lua

@@ -238,8 +238,13 @@ end
 --- Helper function to return a string containing the grid entity's type and variant.
 function ____exports.getGridEntityID(self, gridEntity)
     local gridEntityType = gridEntity:GetType()
-    local gridEntityVariant = gridEntity:GetVariant()
-    return (tostring(gridEntityType) .. ".") .. tostring(gridEntityVariant)
+    local variant = gridEntity:GetVariant()
+    return (tostring(gridEntityType) .. ".") .. tostring(variant)
+end
+--- Helper function to return a formatted string in the format returned by the `getGridEntityID`
+-- function.
+function ____exports.getGridEntityIDFromConstituents(self, gridEntityType, variant)
+    return (tostring(gridEntityType) .. ".") .. tostring(variant)
 end
 --- Helper function to get all of the grid entities in the room that specifically match the type and
 -- variant provided.

package/functions/kColor.d.ts

@@ -18,8 +18,6 @@ interface CopyKColorReturn {
  */
 export declare function copyKColor<K extends KColor | SerializedKColor, S extends SerializationType>(kColor: K, serializationType: S): CopyKColorReturn[S];
 export declare function copyKColor<K extends KColor | SerializedKColor>(kColor: K): CopyKColorReturn[SerializationType.NONE];
-/** Returns `KColor(1, 1, 1, 1)`. */
-export declare function getDefaultKColor(): KColor;
 /** Helper function to check if something is an instantiated KColor object. */
 export declare function isKColor(object: unknown): object is KColor;
 /**

package/functions/kColor.lua

@@ -80,10 +80,6 @@ function ____exports.copyKColor(self, kColor, serializationType)
         end
     until true
 end
---- Returns `KColor(1, 1, 1, 1)`.
-function ____exports.getDefaultKColor(self)
-    return KColor(1, 1, 1, 1)
-end
 --- Used to determine is the given table is a serialized `KColor` object created by the save data
 -- manager and/or the `deepCopy` function.
 function ____exports.isSerializedKColor(self, object)

package/functions/log.lua

@@ -247,7 +247,8 @@ function ____exports.logEntityFlags(flags)
     ____exports.logFlags(flags, EntityFlag, "entity")
 end
 function ____exports.logEntityID(entity)
-    ____exports.log((((("Entity: " .. tostring(entity.Type)) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType))
+    local entityID = getEntityID(nil, entity)
+    ____exports.log("Entity: " .. entityID)
 end
 --- Helper function to log an error message and also print it to the console for better visibility.
 -- 

package/functions/playerCenter.d.ts

@@ -1,5 +1,9 @@
 /**
- * Helper function to move all of the players to the center of the room.
+ * Helper function to move all of the players to where they would normally go when arriving at a new
+ * floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
+ * door.)
+ *
+ * If there is more than one player, they will be distributed around the center in a circle.
  *
  * This function emulates what happens in the vanilla game when you travel to a new floor.
  */

package/functions/playerCenter.lua

@@ -4,6 +4,9 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____constants = require("constants")
+local NEW_FLOOR_STARTING_POSITION_GREED_MODE = ____constants.NEW_FLOOR_STARTING_POSITION_GREED_MODE
+local NEW_FLOOR_STARTING_POSITION_NORMAL_MODE = ____constants.NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
 local ____familiars = require("functions.familiars")
 local getPlayerFamiliars = ____familiars.getPlayerFamiliars
 local ____math = require("functions.math")
@@ -18,24 +21,28 @@ function movePlayerAndTheirFamiliars(self, player, position)
     end
 end
 local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
---- Helper function to move all of the players to the center of the room.
+--- Helper function to move all of the players to where they would normally go when arriving at a new
+-- floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
+-- door.)
+-- 
+-- If there is more than one player, they will be distributed around the center in a circle.
 -- 
 -- This function emulates what happens in the vanilla game when you travel to a new floor.
 function ____exports.movePlayersToCenter(self)
-    local room = game:GetRoom()
-    local centerPos = room:GetCenterPos()
+    local isGreedMode = game:IsGreedMode()
+    local startingPosition = isGreedMode and NEW_FLOOR_STARTING_POSITION_GREED_MODE or NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
     local players = getPlayers(nil)
     local firstPlayer = players[1]
     if firstPlayer == nil then
         return
     end
     if #players == 1 then
-        movePlayerAndTheirFamiliars(nil, firstPlayer, centerPos)
+        movePlayerAndTheirFamiliars(nil, firstPlayer, startingPosition)
         return
     end
     local circlePoints = getCircleDiscretizedPoints(
         nil,
-        centerPos,
+        startingPosition,
         CIRCLE_RADIUS_BETWEEN_PLAYERS,
         #players,
         1,
@@ -46,9 +53,9 @@ function ____exports.movePlayersToCenter(self)
         local i = 0
         while i < #players do
             local player = players[i + 1]
-            local position = circlePoints[i + 1]
-            if player ~= nil and position ~= nil then
-                player.Position = position
+            local circlePosition = circlePoints[i + 1]
+            if player ~= nil and circlePosition ~= nil then
+                player.Position = circlePosition
             end
             i = i + 1
         end

package/functions/playerIndex.d.ts

@@ -44,6 +44,9 @@ export declare function getPlayerIndex(player: EntityPlayer, differentiateForgot
 /**
  * Helper function to return the index of this player with respect to the output of the
  * `Isaac.GetPlayer` method.
+ *
+ * Note that if you storing information about a player in a data structure, you never want to use
+ * this index; use the `getPlayerIndex` function instead.
  */
 export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int | undefined;
 /**

package/functions/playerIndex.lua

@@ -155,6 +155,9 @@ function ____exports.getPlayerFromIndex(self, playerIndex)
 end
 --- Helper function to return the index of this player with respect to the output of the
 -- `Isaac.GetPlayer` method.
+-- 
+-- Note that if you storing information about a player in a data structure, you never want to use
+-- this index; use the `getPlayerIndex` function instead.
 function ____exports.getPlayerIndexVanilla(self, playerToFind)
     local numPlayers = game:GetNumPlayers()
     local playerToFindHash = GetPtrHash(playerToFind)

package/functions/roomShape.d.ts

@@ -1,4 +1,5 @@
 import { DoorSlot, RoomShape } from "isaac-typescript-definitions";
+import { Corner } from "../interfaces/Corner";
 /**
  * Helper function to get the grid index delta that a door out of the given room shape would lead
  * to. For example, if you went through the bottom door in a room of `RoomShape.SHAPE_1x2`, you
@@ -12,7 +13,7 @@ export declare function getGridIndexDelta(roomShape: RoomShape, doorSlot: DoorSl
  *
  * For example, `RoomShape.SHAPE_2x2` will return 2.
  */
-export declare function getRoomShapeBottomRightPosition(roomShape: RoomShape): Vector;
+export declare function getRoomShapeBottomRightPosition(roomShape: RoomShape): Readonly<Vector>;
 /**
  * Helper function to get the grid position of the bottom-right tile of a given room shape.
  *
@@ -21,10 +22,14 @@ export declare function getRoomShapeBottomRightPosition(roomShape: RoomShape): V
  */
 export declare function getRoomShapeBounds(roomShape: RoomShape): readonly [width: int, height: int];
 /**
- * Helper function to get the bounds of a room shape, which are a box representing its contents.
- * This does not include the tiles that the walls are on. L rooms use the same bounds as a 2x2 room.
+ * Helper function to get the number of charges that a given room shape will grant to a player upon
+ * clearing it.
+ *
+ * For example, `RoomShape.SHAPE_2x2` will return 2.
  */
 export declare function getRoomShapeCharges(roomShape: RoomShape): int;
+/** Helper function to get the corners that exist in the given room shape. */
+export declare function getRoomShapeCorners(roomShape: RoomShape): readonly Corner[];
 /**
  * Helper function to get the dimensions of a room shape's layout. This is NOT the size of the
  * room's actual contents! For that, use the `getRoomShapeBounds` function.
@@ -38,7 +43,7 @@ export declare function getRoomShapeLayoutSize(roomShape: RoomShape): readonly [
  * "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 function getRoomShapeTopLeftPosition(roomShape: RoomShape): Vector;
+export declare function getRoomShapeTopLeftPosition(roomShape: RoomShape): Readonly<Vector>;
 /**
  * Helper function to get the volume of a room shape, which is the amount of tiles that are inside
  * the room.
@@ -48,6 +53,7 @@ export declare function getRoomShapeTopLeftPosition(roomShape: RoomShape): Vecto
 export declare function getRoomShapeVolume(roomShape: RoomShape): int;
 export declare function getRoomShapeWidth(roomShape: RoomShape): int;
 export declare function isLRoom(roomShape: RoomShape): boolean;
+export declare function isNarrowRoom(roomShape: RoomShape): boolean;
 /**
  * Helper function to see if a given room shape will grant a single charge or a double charge to the
  * player's active item(s).

package/functions/roomShape.lua

@@ -5,6 +5,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 local ____roomShapeBounds = require("objects.roomShapeBounds")
 local ROOM_SHAPE_BOUNDS = ____roomShapeBounds.ROOM_SHAPE_BOUNDS
+local ____roomShapeCorners = require("objects.roomShapeCorners")
+local ROOM_SHAPE_CORNERS = ____roomShapeCorners.ROOM_SHAPE_CORNERS
 local ____roomShapeLayoutSizes = require("objects.roomShapeLayoutSizes")
 local ROOM_SHAPE_LAYOUT_SIZES = ____roomShapeLayoutSizes.ROOM_SHAPE_LAYOUT_SIZES
 local ____roomShapeToBottomRightPosition = require("objects.roomShapeToBottomRightPosition")
@@ -19,6 +21,8 @@ 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
+local ____narrowRoomShapesSet = require("sets.narrowRoomShapesSet")
+local NARROW_ROOM_SHAPES_SET = ____narrowRoomShapesSet.NARROW_ROOM_SHAPES_SET
 --- Helper function to see if a given room shape will grant a single charge or a double charge to the
 -- player's active item(s).
 -- 
@@ -48,11 +52,17 @@ end
 function ____exports.getRoomShapeBounds(self, roomShape)
     return ROOM_SHAPE_BOUNDS[roomShape]
 end
---- Helper function to get the bounds of a room shape, which are a box representing its contents.
--- This does not include the tiles that the walls are on. L rooms use the same bounds as a 2x2 room.
+--- Helper function to get the number of charges that a given room shape will grant to a player upon
+-- clearing it.
+-- 
+-- For example, `RoomShape.SHAPE_2x2` will return 2.
 function ____exports.getRoomShapeCharges(self, roomShape)
     return ____exports.isRoomShapeDoubleCharge(nil, roomShape) and 2 or 1
 end
+--- Helper function to get the corners that exist in the given room shape.
+function ____exports.getRoomShapeCorners(self, roomShape)
+    return ROOM_SHAPE_CORNERS[roomShape]
+end
 --- Helper function to get the dimensions of a room shape's layout. This is NOT the size of the
 -- room's actual contents! For that, use the `getRoomShapeBounds` function.
 -- 
@@ -80,4 +90,7 @@ end
 function ____exports.isLRoom(self, roomShape)
     return L_ROOM_SHAPES_SET:has(roomShape)
 end
+function ____exports.isNarrowRoom(self, roomShape)
+    return NARROW_ROOM_SHAPES_SET:has(roomShape)
+end
 return ____exports

package/functions/sprite.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to clear a specific layer from a sprite.
+ * Helper function to clear all layers or specific layers from a sprite.
  *
  * This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
  * are passed, it will clear every layer.

package/functions/sprite.lua

@@ -12,7 +12,7 @@ function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
     local kColor2 = sprite2:GetTexel(position, VectorZero, 1, layerID)
     return kColorEquals(nil, kColor1, kColor2)
 end
---- Helper function to clear a specific layer from a sprite.
+--- Helper function to clear all layers or specific layers from a sprite.
 -- 
 -- This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
 -- are passed, it will clear every layer.

package/functions/ui.d.ts

@@ -23,9 +23,11 @@ export declare function getHeartRowLength(player: EntityPlayer): int;
  * combination with the the `getHUDOffsetVector` helper function.
  */
 export declare function getHeartsUIWidth(): int;
+export declare function getScreenBottomCenterPos(): Vector;
 export declare function getScreenBottomLeftPos(): Vector;
 export declare function getScreenBottomRightPos(): Vector;
 export declare function getScreenCenterPos(): Vector;
+export declare function getScreenTopCenterPos(): Vector;
 export declare function getScreenTopLeftPos(): Vector;
 export declare function getScreenTopRightPos(): Vector;
 /**

package/functions/ui.lua

@@ -79,6 +79,10 @@ function ____exports.getHeartsUIWidth(self)
     end
     return width
 end
+function ____exports.getScreenBottomCenterPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRight.X / 2, bottomRight.Y)
+end
 function ____exports.getScreenBottomLeftPos(self)
     local bottomRight = ____exports.getScreenBottomRightPos(nil)
     return Vector(0, bottomRight.Y)
@@ -87,6 +91,10 @@ function ____exports.getScreenCenterPos(self)
     local bottomRight = ____exports.getScreenBottomRightPos(nil)
     return bottomRight / 2
 end
+function ____exports.getScreenTopCenterPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRight.X / 2, 0)
+end
 function ____exports.getScreenTopLeftPos(self)
     return copyVector(nil, VectorZero)
 end