isaacscript-common 6.2.1 → 6.5.0

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.
@@ -70,31 +70,36 @@ export declare function isDevilRoomDoor(door: GridEntityDoor): boolean;
 export declare function isDoorSlotInRoomShape(doorSlot: DoorSlot, roomShape: RoomShape): boolean;
 /**
  * This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
- * to spend one key to open it. It has a sprite filename of "gfx/grid/Door_Downpour.anm2".
+ * to spend one key to open it. It has a sprite filename of "gfx/grid/door_downpour.anm2".
  */
 export declare function isDoorToDownpour(door: GridEntityDoor): boolean;
 /**
  * This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
- * to spend two hearts to open it. It has a sprite filename of "gfx/grid/Door_Mausoleum.anm2".
+ * to spend two hearts to open it. It has a sprite filename of "gfx/grid/door_mausoleum.anm2".
  */
 export declare function isDoorToMausoleum(door: GridEntityDoor): boolean;
 /**
  * This refers to the "strange door" located on the first room of Depths 2. You open it with either
- * a Polaroid or a Negative. It has a sprite filename of "gfx/grid/Door_Mausoleum_Alt.anm2".
+ * a Polaroid or a Negative. It has a sprite filename of "gfx/grid/door_mausoleum_alt.anm2".
  */
 export declare function isDoorToMausoleumAscent(door: GridEntityDoor): boolean;
 /**
  * This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
- * to spend two bombs to open it. It has a sprite filename of "gfx/grid/Door_Mines.anm2".
+ * to spend two bombs to open it. It has a sprite filename of "gfx/grid/door_mines.anm2".
  */
 export declare function isDoorToMines(door: GridEntityDoor): boolean;
 /**
  * This refers to the Repentance door that spawns after defeating Mom. You open it with the
- * completed knife. It has a sprite filename of "gfx/grid/Door_MomsHeart.anm2".
+ * completed knife. It has a sprite filename of "gfx/grid/door_momsheart.anm2".
  */
 export declare function isDoorToMomsHeart(door: GridEntityDoor): boolean;
 export declare function isHiddenSecretRoomDoor(door: GridEntityDoor): boolean;
 export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
+/**
+ * This refers to the hole in the wall that appears after bombing the entrance to a secret room.
+ * Note that the door still exists before it has been bombed open. It has a sprite filename of
+ * "gfx/grid/door_08_holeinwall.anm2".
+ */
 export declare function isSecretRoomDoor(door: GridEntityDoor): boolean;
 /**
  * Helper function to reset an unlocked door back to a locked state. Doing this is non-trivial

package/functions/doors.lua

@@ -77,10 +77,13 @@ end
 function ____exports.isRepentanceDoor(self, door)
     return door.TargetRoomIndex == GridRoom.SECRET_EXIT
 end
+--- This refers to the hole in the wall that appears after bombing the entrance to a secret room.
+-- Note that the door still exists before it has been bombed open. It has a sprite filename of
+-- "gfx/grid/door_08_holeinwall.anm2".
 function ____exports.isSecretRoomDoor(self, door)
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_08_HoleInWall.anm2"
+    return filename == "gfx/grid/door_08_holeinwall.anm2"
 end
 --- Helper function to remove a single door.
 function ____exports.removeDoor(self, door)
@@ -234,54 +237,54 @@ function ____exports.isDoorSlotInRoomShape(self, doorSlot, roomShape)
     return doorSlots:has(doorSlot)
 end
 --- This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
--- to spend one key to open it. It has a sprite filename of "gfx/grid/Door_Downpour.anm2".
+-- to spend one key to open it. It has a sprite filename of "gfx/grid/door_downpour.anm2".
 function ____exports.isDoorToDownpour(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_Downpour.anm2"
+    return string.lower(filename) == "gfx/grid/door_downpour.anm2"
 end
 --- This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
--- to spend two hearts to open it. It has a sprite filename of "gfx/grid/Door_Mausoleum.anm2".
+-- to spend two hearts to open it. It has a sprite filename of "gfx/grid/door_mausoleum.anm2".
 function ____exports.isDoorToMausoleum(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_Mausoleum.anm2"
+    return string.lower(filename) == "gfx/grid/door_mausoleum.anm2"
 end
 --- This refers to the "strange door" located on the first room of Depths 2. You open it with either
--- a Polaroid or a Negative. It has a sprite filename of "gfx/grid/Door_Mausoleum_Alt.anm2".
+-- a Polaroid or a Negative. It has a sprite filename of "gfx/grid/door_mausoleum_alt.anm2".
 function ____exports.isDoorToMausoleumAscent(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_Mausoleum_Alt.anm2"
+    return string.lower(filename) == "gfx/grid/door_mausoleum_alt.anm2"
 end
 --- This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
--- to spend two bombs to open it. It has a sprite filename of "gfx/grid/Door_Mines.anm2".
+-- to spend two bombs to open it. It has a sprite filename of "gfx/grid/door_mines.anm2".
 function ____exports.isDoorToMines(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_Mines.anm2"
+    return string.lower(filename) == "gfx/grid/door_mines.anm2"
 end
 --- This refers to the Repentance door that spawns after defeating Mom. You open it with the
--- completed knife. It has a sprite filename of "gfx/grid/Door_MomsHeart.anm2".
+-- completed knife. It has a sprite filename of "gfx/grid/door_momsheart.anm2".
 function ____exports.isDoorToMomsHeart(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_MomsHeart.anm2"
+    return filename == "gfx/grid/door_momsheart.anm2"
 end
 function ____exports.isHiddenSecretRoomDoor(self, door)
     local sprite = door:GetSprite()

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

@@ -1,4 +1,5 @@
 import { GridEntityType, GridEntityXMLType } from "isaac-typescript-definitions";
+import { RockAltType } from "../enums/RockAltType";
 /**
  * Helper function to convert the grid entity type found in a room XML file to the corresponding
  * grid entity type and variant normally used by the game. For example, a rock is represented as
@@ -61,11 +62,31 @@ 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.
  */
 export declare function getMatchingGridEntities(gridEntityType: GridEntityType, variant: int): GridEntity[];
+/**
+ * Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
+ * will have.
+ *
+ * The rock type is based on the backdrop of the room.
+ *
+ * For example, if you change the backdrop of the starting room of the run to `BackdropType.CAVES`,
+ * and then spawn `GridEntityType.ROCK_ALT`, it will be a mushroom instead of an urn. Additionally,
+ * if it is destroyed, it will generate mushroom-appropriate rewards.
+ *
+ * On the other hand, if an urn is spawned first before the backdrop is changed to
+ * `BackdropType.CAVES`, the graphic of the urn will not switch to a mushroom. However, when
+ * destroyed, the urn will still generate mushroom-appropriate rewards.
+ */
+export declare function getRockAltType(): RockAltType;
 export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 export declare function getTopLeftWall(): GridEntity | undefined;
 /**
@@ -173,6 +194,24 @@ export declare function spawnGrid(gridEntityType: GridEntityType, gridIndexOrPos
  * - allows you to specify the grid index or the position
  */
 export declare function spawnGridWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+/**
+ * Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
+ * breaks.
+ *
+ * Note that most of the time, this function will do nothing, similar to how most of the time, when
+ * an individual urn is destroyed, nothing will spawn.
+ *
+ * The logic in this function is based on the rewards listed on the wiki:
+ * https://bindingofisaacrebirth.fandom.com/wiki/Rocks
+ *
+ * @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
+ *                    at spawning coins and spiders.
+ * @param _seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
+ *                   the `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally,
+ *                   you should pass the `InitSeed` of the grid entity that was broken.
+ * @returns Whether or not this function spawned something.
+ */
+export declare function spawnRockAltReward(rockAltType: RockAltType, _seedOrRNG?: Seed | RNG): boolean;
 /**
  * Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
  * with the appropriate variant, as the game does not give it the correct sprite automatically.

package/functions/gridEntity.lua

@@ -15,6 +15,8 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constants = require("constants")
 local DISTANCE_OF_GRID_TILE = ____constants.DISTANCE_OF_GRID_TILE
+local ____RockAltType = require("enums.RockAltType")
+local RockAltType = ____RockAltType.RockAltType
 local ____gridEntityTypeToBrokenStateMap = require("maps.gridEntityTypeToBrokenStateMap")
 local GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP = ____gridEntityTypeToBrokenStateMap.GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP
 local ____gridEntityXMLMap = require("maps.gridEntityXMLMap")
@@ -22,8 +24,12 @@ local GRID_ENTITY_XML_MAP = ____gridEntityXMLMap.GRID_ENTITY_XML_MAP
 local ____roomShapeToTopLeftWallGridIndexMap = require("maps.roomShapeToTopLeftWallGridIndexMap")
 local DEFAULT_TOP_LEFT_WALL_GRID_INDEX = ____roomShapeToTopLeftWallGridIndexMap.DEFAULT_TOP_LEFT_WALL_GRID_INDEX
 local ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = ____roomShapeToTopLeftWallGridIndexMap.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP
+local ____backdropTypeToRockAltType = require("objects.backdropTypeToRockAltType")
+local BACKDROP_TYPE_TO_ROCK_ALT_TYPE = ____backdropTypeToRockAltType.BACKDROP_TYPE_TO_ROCK_ALT_TYPE
 local ____math = require("functions.math")
 local isCircleIntersectingRectangle = ____math.isCircleIntersectingRectangle
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
 local ____rooms = require("functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
 local ____sprite = require("functions.sprite")
@@ -238,8 +244,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.
@@ -250,6 +261,23 @@ function ____exports.getMatchingGridEntities(self, gridEntityType, variant)
         function(____, gridEntity) return gridEntity:GetVariant() == variant end
     )
 end
+--- Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
+-- will have.
+-- 
+-- The rock type is based on the backdrop of the room.
+-- 
+-- For example, if you change the backdrop of the starting room of the run to `BackdropType.CAVES`,
+-- and then spawn `GridEntityType.ROCK_ALT`, it will be a mushroom instead of an urn. Additionally,
+-- if it is destroyed, it will generate mushroom-appropriate rewards.
+-- 
+-- On the other hand, if an urn is spawned first before the backdrop is changed to
+-- `BackdropType.CAVES`, the graphic of the urn will not switch to a mushroom. However, when
+-- destroyed, the urn will still generate mushroom-appropriate rewards.
+function ____exports.getRockAltType(self)
+    local room = game:GetRoom()
+    local backdropType = room:GetBackdropType()
+    return BACKDROP_TYPE_TO_ROCK_ALT_TYPE[backdropType]
+end
 function ____exports.getSurroundingGridEntities(self, gridEntity)
     local room = game:GetRoom()
     local gridWidth = room:GetGridWidth()
@@ -395,6 +423,59 @@ end
 function ____exports.spawnGrid(self, gridEntityType, gridIndexOrPosition)
     return ____exports.spawnGridWithVariant(nil, gridEntityType, 0, gridIndexOrPosition)
 end
+--- Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
+-- breaks.
+-- 
+-- Note that most of the time, this function will do nothing, similar to how most of the time, when
+-- an individual urn is destroyed, nothing will spawn.
+-- 
+-- The logic in this function is based on the rewards listed on the wiki:
+-- https://bindingofisaacrebirth.fandom.com/wiki/Rocks
+-- 
+-- @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
+-- at spawning coins and spiders.
+-- @param _seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
+-- the `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally,
+-- you should pass the `InitSeed` of the grid entity that was broken.
+-- @returns Whether or not this function spawned something.
+function ____exports.spawnRockAltReward(self, rockAltType, _seedOrRNG)
+    if _seedOrRNG == nil then
+        _seedOrRNG = getRandomSeed(nil)
+    end
+    repeat
+        local ____switch56 = rockAltType
+        local ____cond56 = ____switch56 == RockAltType.URN
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+        ____cond56 = ____cond56 or ____switch56 == RockAltType.MUSHROOM
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+        ____cond56 = ____cond56 or ____switch56 == RockAltType.SKULL
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+        ____cond56 = ____cond56 or ____switch56 == RockAltType.POLYP
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+        ____cond56 = ____cond56 or ____switch56 == RockAltType.BUCKET
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+    until true
+end
 --- Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
 -- with the appropriate variant, as the game does not give it the correct sprite automatically.
 function ____exports.spawnVoidPortal(self, gridIndex)

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/pickups.d.ts

@@ -1,29 +1,29 @@
 import { BatterySubType, Card, CoinSubType, CollectibleType, HeartSubType, KeySubType, PillColor, SackSubType, TrinketType } from "isaac-typescript-definitions";
 /** Helper function to get all of the battery entities in the room. */
-export declare function getBatteries(matchingSubType?: number): EntityPickupBattery[];
+export declare function getBatteries(matchingSubType?: BatterySubType | -1): EntityPickupBattery[];
 /** Helper function to get all of the card entities in the room. */
-export declare function getCards(matchingSubType?: number): EntityPickupCard[];
+export declare function getCards(matchingSubType?: Card | -1): EntityPickupCard[];
 /**
  * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
  * sub-types.
  */
 export declare function getCoinValue(coinSubType: CoinSubType): int;
 /** Helper function to get all of the coin pickup entities in the room. */
-export declare function getCoins(matchingSubType?: number): EntityPickupCoin[];
+export declare function getCoins(matchingSubType?: CoinSubType | -1): EntityPickupCoin[];
 /** Helper function to get all of the collectible entities in the room. */
-export declare function getCollectibles(matchingSubType?: number): EntityPickupCollectible[];
+export declare function getCollectibles(matchingSubType?: CollectibleType | -1): EntityPickupCollectible[];
 /** Helper function to get all of the heart pickup entities in the room. */
-export declare function getHearts(matchingSubType?: number): EntityPickupHeart[];
+export declare function getHearts(matchingSubType?: HeartSubType | -1): EntityPickupHeart[];
 /** Helper function to get all of the key pickup entities in the room. */
-export declare function getKeys(matchingSubType?: number): EntityPickupKey[];
+export declare function getKeys(matchingSubType?: KeySubType | -1): EntityPickupKey[];
 /** Helper function to get all of the pill entities in the room. */
-export declare function getPills(matchingSubType?: number): EntityPickupPill[];
+export declare function getPills(matchingSubType?: PillColor | -1): EntityPickupPill[];
 /** Helper function to get all of the red heart pickup entities in the room. */
 export declare function getRedHearts(): EntityPickupHeart[];
 /** Helper function to get all of the sack (i.e. grab bag) entities in the room. */
-export declare function getSacks(matchingSubType?: number): EntityPickupSack[];
+export declare function getSacks(matchingSubType?: SackSubType | -1): EntityPickupSack[];
 /** Helper function to get all of the trinket entities in the room. */
-export declare function getTrinkets(matchingSubType?: number): EntityPickupTrinket[];
+export declare function getTrinkets(matchingSubType?: TrinketType | -1): EntityPickupTrinket[];
 export declare function isChest(pickup: EntityPickup): boolean;
 export declare function isRedHeart(pickup: EntityPickup): boolean;
 /**

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")
@@ -17,10 +20,6 @@ function movePlayerAndTheirFamiliars(self, player, position)
         familiar.Position = position
     end
 end
---- This is in the center of the room.
-local NORMAL_MODE_NEW_FLOOR_STARTING_POSITION = Vector(320, 380)
---- This is near the top door.
-local GREED_MODE_NEW_FLOOR_STARTING_POSITION = Vector(320, 280)
 local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
 --- 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
@@ -31,7 +30,7 @@ local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
 -- This function emulates what happens in the vanilla game when you travel to a new floor.
 function ____exports.movePlayersToCenter(self)
     local isGreedMode = game:IsGreedMode()
-    local startingPosition = isGreedMode and GREED_MODE_NEW_FLOOR_STARTING_POSITION or NORMAL_MODE_NEW_FLOOR_STARTING_POSITION
+    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

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/run.d.ts

@@ -13,3 +13,10 @@ export declare function onSetSeed(): boolean;
  * You can optionally specify a `PlayerType` to restart the game as that character.
  */
 export declare function restart(character?: PlayerType): void;
+/**
+ * Helper function to change the run status to that of an unseeded run with a new random seed.
+ *
+ * This is useful to revert the behavior where playing on a set and restarting the game will not
+ * take you to a new seed.
+ */
+export declare function setUnseeded(): void;

package/functions/run.lua

@@ -1,6 +1,7 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constantsFirstLast = require("constantsFirstLast")
@@ -23,14 +24,25 @@ end
 -- You can optionally specify a `PlayerType` to restart the game as that character.
 function ____exports.restart(self, character)
     if character == nil then
-        log("Restarting.")
-        Isaac.ExecuteCommand("restart")
+        local command = "restart"
+        log("Restarting the run with a console command of: " .. command)
+        Isaac.ExecuteCommand(command)
         return
     end
     if character < FIRST_CHARACTER then
         error(("Restarting as a character of " .. tostring(character)) .. " would crash the game.")
     end
-    log("Restarting as character: " .. tostring(character))
-    Isaac.ExecuteCommand("restart " .. tostring(character))
+    local command = "restart " .. tostring(character)
+    log((((("Restarting the run as PlayerType." .. tostring(PlayerType[character])) .. " (") .. tostring(character)) .. ") with a console command of: ") .. command)
+    Isaac.ExecuteCommand(command)
+end
+--- Helper function to change the run status to that of an unseeded run with a new random seed.
+-- 
+-- This is useful to revert the behavior where playing on a set and restarting the game will not
+-- take you to a new seed.
+function ____exports.setUnseeded(self)
+    local seeds = game:GetSeeds()
+    seeds:Reset()
+    seeds:Restart(Challenge.NULL)
 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.