isaacscript-common 6.0.1 → 6.2.0

package/functions/entitySpecific.d.ts

@@ -223,42 +223,42 @@ export declare function removeAllSlots(slotVariant?: SlotVariant, subType?: int,
  */
 export declare function removeAllTears(tearVariant?: TearVariant, subType?: int, cap?: int): EntityTear[];
 /** Helper function to spawn a `EntityType.BOMB` (4). */
-export declare function spawnBomb(bombVariant: BombVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityBomb;
+export declare function spawnBomb(bombVariant: BombVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityBomb;
 /** Helper function to spawn a `EntityType.BOMB` (4) with a specific seed. */
-export declare function spawnBombWithSeed(bombVariant: BombVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityBomb;
+export declare function spawnBombWithSeed(bombVariant: BombVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityBomb;
 /** Helper function to spawn a `EntityType.EFFECT` (1000). */
-export declare function spawnEffect(effectVariant: EffectVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityEffect;
+export declare function spawnEffect(effectVariant: EffectVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityEffect;
 /** Helper function to spawn a `EntityType.EFFECT` (1000) with a specific seed. */
-export declare function spawnEffectWithSeed(effectVariant: EffectVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityEffect;
+export declare function spawnEffectWithSeed(effectVariant: EffectVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityEffect;
 /** Helper function to spawn a `EntityType.FAMILIAR` (3). */
-export declare function spawnFamiliar(familiarVariant: FamiliarVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityFamiliar;
+export declare function spawnFamiliar(familiarVariant: FamiliarVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityFamiliar;
 /** Helper function to spawn a `EntityType.FAMILIAR` (3) with a specific seed. */
-export declare function spawnFamiliarWithSeed(familiarVariant: FamiliarVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityFamiliar;
+export declare function spawnFamiliarWithSeed(familiarVariant: FamiliarVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityFamiliar;
 /** Helper function to spawn a `EntityType.KNIFE` (8). */
-export declare function spawnKnife(knifeVariant: KnifeVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityKnife;
+export declare function spawnKnife(knifeVariant: KnifeVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityKnife;
 /** Helper function to spawn a `EntityType.KNIFE` (8) with a specific seed. */
-export declare function spawnKnifeWithSeed(knifeVariant: KnifeVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityKnife;
+export declare function spawnKnifeWithSeed(knifeVariant: KnifeVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityKnife;
 /** Helper function to spawn a `EntityType.LASER` (7). */
-export declare function spawnLaser(laserVariant: LaserVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityLaser;
+export declare function spawnLaser(laserVariant: LaserVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityLaser;
 /** Helper function to spawn a `EntityType.LASER` (7) with a specific seed. */
-export declare function spawnLaserWithSeed(laserVariant: LaserVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
+export declare function spawnLaserWithSeed(laserVariant: LaserVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityLaser;
 /** Helper function to spawn an NPC. */
-export declare function spawnNPC(entityType: EntityType, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityNPC;
+export declare function spawnNPC(entityType: EntityType, variant: int, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityNPC;
 /** Helper function to spawn an NPC with a specific seed. */
-export declare function spawnNPCWithSeed(entityType: EntityType, variant: int, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityNPC;
+export declare function spawnNPCWithSeed(entityType: EntityType, variant: int, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityNPC;
 /** Helper function to spawn a `EntityType.PICKUP` (5). */
-export declare function spawnPickup(pickupVariant: PickupVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickup;
+export declare function spawnPickup(pickupVariant: PickupVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with a specific seed. */
-export declare function spawnPickupWithSeed(pickupVariant: PickupVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnPickupWithSeed(pickupVariant: PickupVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.PROJECTILE` (9). */
-export declare function spawnProjectile(projectileVariant: ProjectileVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityProjectile;
+export declare function spawnProjectile(projectileVariant: ProjectileVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityProjectile;
 /** Helper function to spawn a `EntityType.PROJECTILE` (9) with a specific seed. */
-export declare function spawnProjectileWithSeed(projectileVariant: ProjectileVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityProjectile;
+export declare function spawnProjectileWithSeed(projectileVariant: ProjectileVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityProjectile;
 /** Helper function to spawn a `EntityType.SLOT` (6). */
-export declare function spawnSlot(slotVariant: SlotVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntitySlot;
+export declare function spawnSlot(slotVariant: SlotVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntitySlot;
 /** Helper function to spawn a `EntityType.SLOT` (6) with a specific seed. */
-export declare function spawnSlotWithSeed(slotVariant: SlotVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntitySlot;
+export declare function spawnSlotWithSeed(slotVariant: SlotVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntitySlot;
 /** Helper function to spawn a `EntityType.TEAR` (2). */
-export declare function spawnTear(tearVariant: TearVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityTear;
+export declare function spawnTear(tearVariant: TearVariant, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityTear;
 /** Helper function to spawn a `EntityType.EntityType` (2) with a specific seed. */
-export declare function spawnTearWithSeed(tearVariant: TearVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;
+export declare function spawnTearWithSeed(tearVariant: TearVariant, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityTear;

package/functions/familiars.d.ts

@@ -57,4 +57,6 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: Col
  *                        spawn new familiars with a sub-type of 0.
  */
 export declare function checkFamiliarFromCollectibles(player: EntityPlayer, collectibleType: CollectibleType, familiarVariant: FamiliarVariant, familiarSubType?: int): void;
+/** Helper function to get only the familiars that belong to a specific player. */
+export declare function getPlayerFamiliars(player: EntityPlayer): EntityFamiliar[];
 export declare function isFamiliarThatShootsPlayerTears(familiar: EntityFamiliar): boolean;

package/functions/familiars.lua

@@ -1,8 +1,12 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____familiarsThatShootPlayerTearsSet = require("sets.familiarsThatShootPlayerTearsSet")
 local FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET = ____familiarsThatShootPlayerTearsSet.FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET
+local ____entitySpecific = require("functions.entitySpecific")
+local getFamiliars = ____entitySpecific.getFamiliars
 --- Helper function to add and remove familiars based on a target amount that you specify.
 -- 
 -- This is a convenience wrapper around the `EntityPlayer.CheckFamiliar` method. Use this helper
@@ -79,6 +83,18 @@ function ____exports.checkFamiliarFromCollectibles(self, player, collectibleType
         familiarSubType
     )
 end
+--- Helper function to get only the familiars that belong to a specific player.
+function ____exports.getPlayerFamiliars(self, player)
+    local playerPtrHash = GetPtrHash(player)
+    local familiars = getFamiliars(nil)
+    return __TS__ArrayFilter(
+        familiars,
+        function(____, familiar)
+            local familiarPlayerPtrHash = GetPtrHash(familiar.Player)
+            return familiarPlayerPtrHash == playerPtrHash
+        end
+    )
+end
 function ____exports.isFamiliarThatShootsPlayerTears(self, familiar)
     return FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET:has(familiar.Variant)
 end

package/functions/jsonRoom.d.ts

@@ -1,8 +1,24 @@
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-import { JSONRoom } from "../interfaces/JSONRoom";
+import { DoorSlotFlag } from "isaac-typescript-definitions";
+import { JSONRoom } from "../interfaces/JSONRoomsFile";
+/**
+ * Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
+ * given JSON room.
+ */
+export declare function getJSONRoomDoorSlotFlags(jsonRoom: JSONRoom): BitFlags<DoorSlotFlag>;
+/**
+ * Helper function to find a specific room from an array of JSON rooms.
+ *
+ * @param jsonRooms The array of rooms to search through.
+ * @param variant The room variant to select. (The room variant can be thought of as the ID of the
+ *                room.)
+ */
 export declare function getJSONRoomOfVariant(jsonRooms: JSONRoom[] | readonly JSONRoom[], variant: int): JSONRoom | undefined;
+/**
+ * Helper function to find all of the JSON rooms that match the sub-type provided.
+ *
+ * @param jsonRooms The array of rooms to search through.
+ * @param subType The sub-type to match.
+ */
 export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[] | readonly JSONRoom[], subType: int): JSONRoom[];
 /**
  * Helper function to get a random JSON room from an array of JSON rooms.
@@ -10,5 +26,11 @@ export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[] | readonly J
  * Note that this function does not simply choose a random element in the provided array; it will
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
+ *
+ * @param jsonRooms The array of rooms to random choose between.
+ * @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()`.
+ * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+ *                what the function is doing. Default is false.
  */
 export declare function getRandomJSONRoom(jsonRooms: JSONRoom[] | readonly JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONRoom;

package/functions/jsonRoom.lua

@@ -3,8 +3,15 @@ local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local ____exports = {}
 local getTotalWeightOfJSONRooms, getJSONRoomWithChosenWeight
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlotFlagZero = ____isaac_2Dtypescript_2Ddefinitions.DoorSlotFlagZero
 local ____array = require("functions.array")
 local sumArray = ____array.sumArray
+local ____doors = require("functions.doors")
+local doorSlotToDoorSlotFlag = ____doors.doorSlotToDoorSlotFlag
+local getRoomShapeDoorSlot = ____doors.getRoomShapeDoorSlot
+local ____flag = require("functions.flag")
+local addFlag = ____flag.addFlag
 local ____log = require("functions.log")
 local log = ____log.log
 local ____random = require("functions.random")
@@ -37,8 +44,53 @@ function getJSONRoomWithChosenWeight(self, jsonRooms, chosenWeight)
         end
         chosenWeight = chosenWeight - roomWeight
     end
-    return error("Failed to get a JSON room with chosen weight: " .. tostring(chosenWeight))
+    error("Failed to get a JSON room with chosen weight: " .. tostring(chosenWeight))
 end
+--- Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
+-- given JSON room.
+function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
+    local roomShapeString = jsonRoom["$"].shape
+    local roomShapeNumber = tonumber(roomShapeString)
+    if roomShapeNumber == nil then
+        error("Failed to parse the \"shape\" property of a JSON room: " .. roomShapeString)
+    end
+    local roomShape = roomShapeNumber
+    local doorSlotFlags = DoorSlotFlagZero
+    for ____, door in ipairs(jsonRoom.door) do
+        do
+            local existsString = door["$"].exists
+            if existsString ~= "True" and existsString ~= "False" then
+                error("Failed to parse the \"exists\" property of a JSON room door: " .. existsString)
+            end
+            if existsString == "False" then
+                goto __continue4
+            end
+            local xString = door["$"].x
+            local x = tonumber(xString)
+            if x == nil then
+                error("Failed to parse the \"x\" property of a JSON room door: " .. xString)
+            end
+            local yString = door["$"].y
+            local y = tonumber(yString)
+            if y == nil then
+                error("Failed to parse the \"y\" property of a JSON room door: " .. yString)
+            end
+            local doorSlot = getRoomShapeDoorSlot(nil, roomShape, x, y)
+            if doorSlot == nil then
+                error(((("Failed to retrieve the door slot for a JSON room door at coordinates: [" .. tostring(x)) .. ", ") .. tostring(y)) .. "]")
+            end
+            local doorSlotFlag = doorSlotToDoorSlotFlag(nil, doorSlot)
+            doorSlotFlags = addFlag(nil, doorSlotFlags, doorSlotFlag)
+        end
+        ::__continue4::
+    end
+    return doorSlotFlags
+end
+--- Helper function to find a specific room from an array of JSON rooms.
+-- 
+-- @param jsonRooms The array of rooms to search through.
+-- @param variant The room variant to select. (The room variant can be thought of as the ID of the
+-- room.)
 function ____exports.getJSONRoomOfVariant(self, jsonRooms, variant)
     local jsonRoomsOfVariant = __TS__ArrayFilter(
         jsonRooms,
@@ -54,8 +106,12 @@ function ____exports.getJSONRoomOfVariant(self, jsonRooms, variant)
     if #jsonRoomsOfVariant == 1 then
         return jsonRoomsOfVariant[1]
     end
-    return error(((("Found " .. tostring(#jsonRoomsOfVariant)) .. " JSON rooms with a variant of ") .. tostring(variant)) .. ", when there should only be 1.")
+    error(((("Found " .. tostring(#jsonRoomsOfVariant)) .. " JSON rooms with a variant of ") .. tostring(variant)) .. ", when there should only be 1.")
 end
+--- Helper function to find all of the JSON rooms that match the sub-type provided.
+-- 
+-- @param jsonRooms The array of rooms to search through.
+-- @param subType The sub-type to match.
 function ____exports.getJSONRoomsOfSubType(self, jsonRooms, subType)
     return __TS__ArrayFilter(
         jsonRooms,
@@ -71,6 +127,12 @@ end
 -- Note that this function does not simply choose a random element in the provided array; it will
 -- properly account for each room weight using the algorithm from:
 -- https://stackoverflow.com/questions/1761626/weighted-random-numbers
+-- 
+-- @param jsonRooms The array of rooms to random choose between.
+-- @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()`.
+-- @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+-- what the function is doing. Default is false.
 function ____exports.getRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)

package/functions/pickups.d.ts

@@ -103,30 +103,30 @@ export declare function removeAllTrinkets(trinketType?: TrinketType, cap?: int):
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
  */
-export declare function spawnBattery(subType: BatterySubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupBattery;
-export declare function spawnBatteryWithSeed(subType: BatterySubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupBattery;
+export declare function spawnBattery(subType: BatterySubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupBattery;
+export declare function spawnBatteryWithSeed(subType: BatterySubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupBattery;
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TAROT_CARD` (300).
  */
-export declare function spawnCard(subType: Card, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCard;
-export declare function spawnCardWithSeed(subType: Card, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupCard;
+export declare function spawnCard(subType: Card, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCard;
+export declare function spawnCardWithSeed(subType: Card, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupCard;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20). */
-export declare function spawnCoin(subType: CoinSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCoin;
-export declare function spawnCoinWithSeed(subType: CoinSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupCoin;
+export declare function spawnCoin(subType: CoinSubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupCoin;
+export declare function spawnCoinWithSeed(subType: CoinSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupCoin;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10). */
-export declare function spawnHeart(subType: HeartSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupHeart;
-export declare function spawnHeartWithSeed(subType: HeartSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupHeart;
+export declare function spawnHeart(subType: HeartSubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupHeart;
+export declare function spawnHeartWithSeed(subType: HeartSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupHeart;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30). */
-export declare function spawnKey(subType: KeySubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupKey;
-export declare function spawnKeyWithSeed(subType: KeySubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupKey;
+export declare function spawnKey(subType: KeySubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupKey;
+export declare function spawnKeyWithSeed(subType: KeySubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupKey;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70). */
-export declare function spawnPill(pillColor: PillColor, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupPill;
-export declare function spawnPillWithSeed(subType: PillColor, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupPill;
+export declare function spawnPill(pillColor: PillColor, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupPill;
+export declare function spawnPillWithSeed(subType: PillColor, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupPill;
 /** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69). */
-export declare function spawnSack(subType: SackSubType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupSack;
-export declare function spawnSackWithSeed(subType: SackSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupSack;
+export declare function spawnSack(subType: SackSubType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupSack;
+export declare function spawnSackWithSeed(subType: SackSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupSack;
 /**
  * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350).
  */
-export declare function spawnTrinket(subType: TrinketType, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupTrinket;
-export declare function spawnTrinketWithSeed(subType: TrinketType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickupTrinket;
+export declare function spawnTrinket(subType: TrinketType, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): EntityPickupTrinket;
+export declare function spawnTrinketWithSeed(subType: TrinketType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupTrinket;

package/functions/playerCenter.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Helper function to move all of the players to the center of the room.
+ *
+ * This function emulates what happens in the vanilla game when you travel to a new floor.
+ */
+export declare function movePlayersToCenter(): void;

package/functions/playerCenter.lua

@@ -0,0 +1,57 @@
+local ____exports = {}
+local movePlayerAndTheirFamiliars
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____familiars = require("functions.familiars")
+local getPlayerFamiliars = ____familiars.getPlayerFamiliars
+local ____math = require("functions.math")
+local getCircleDiscretizedPoints = ____math.getCircleDiscretizedPoints
+local ____playerIndex = require("functions.playerIndex")
+local getPlayers = ____playerIndex.getPlayers
+function movePlayerAndTheirFamiliars(self, player, position)
+    player.Position = position
+    local familiars = getPlayerFamiliars(nil, player)
+    for ____, familiar in ipairs(familiars) do
+        familiar.Position = position
+    end
+end
+local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
+--- Helper function to move all of the players to the center of the room.
+-- 
+-- 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 players = getPlayers(nil)
+    local firstPlayer = players[1]
+    if firstPlayer == nil then
+        return
+    end
+    if #players == 1 then
+        movePlayerAndTheirFamiliars(nil, firstPlayer, centerPos)
+        return
+    end
+    local circlePoints = getCircleDiscretizedPoints(
+        nil,
+        centerPos,
+        CIRCLE_RADIUS_BETWEEN_PLAYERS,
+        #players,
+        1,
+        1,
+        Direction.LEFT
+    )
+    do
+        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
+            end
+            i = i + 1
+        end
+    end
+end
+return ____exports

package/functions/rooms.d.ts

@@ -55,7 +55,7 @@ export declare function getRoomTypeName(roomType: RoomType): string;
  * non-existent and are not added to the list.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
- *                                 extra-dimensional rooms are automatically be generated and can be
+ *                                 extra-dimensional rooms are automatically generated and can be
  *                                 seen when you iterate over the `RoomList`. Default is false.
  */
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];

package/functions/rooms.lua

@@ -72,7 +72,7 @@ end
 -- non-existent and are not added to the list.
 -- 
 -- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
--- extra-dimensional rooms are automatically be generated and can be
+-- extra-dimensional rooms are automatically generated and can be
 -- seen when you iterate over the `RoomList`. Default is false.
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
     if includeExtraDimensionalRooms == nil then
@@ -145,7 +145,7 @@ function ____exports.getDimension(self)
             return dimension
         end
     end
-    return error("Failed to get the current dimension.")
+    error("Failed to get the current dimension.")
 end
 --- Helper function to get the number of rooms that are currently on the floor layout. This does not
 -- include off-grid rooms, like the Devil Room.

package/functions/stage.d.ts

@@ -16,10 +16,10 @@ export declare function calculateStageTypeRepentance(stage: LevelStage): StageTy
  */
 export declare function getEffectiveStage(): int;
 /**
- * Helper function to get the prefix to use with the "goto" console command that would correspond to
- * the provided room type.
+ * Helper function to get the corresponding "goto" console command that would correspond to the
+ * provided room type and room variant.
  */
-export declare function getGotoCommandPrefix(roomType: RoomType): string;
+export declare function getGotoCommand(roomType: RoomType, roomVariant: int): string;
 /** Alias for the `Level.GetStage` method. */
 export declare function getStage(): LevelStage;
 /** Alias for the `Level.GetStageType` method. */

package/functions/stage.lua

@@ -64,10 +64,11 @@ function ____exports.getEffectiveStage(self)
     end
     return stage
 end
---- Helper function to get the prefix to use with the "goto" console command that would correspond to
--- the provided room type.
-function ____exports.getGotoCommandPrefix(self, roomType)
-    return ROOM_TYPE_GOTO_PREFIXES[roomType]
+--- Helper function to get the corresponding "goto" console command that would correspond to the
+-- provided room type and room variant.
+function ____exports.getGotoCommand(self, roomType, roomVariant)
+    local prefix = ROOM_TYPE_GOTO_PREFIXES[roomType]
+    return (("goto " .. prefix) .. ".") .. tostring(roomVariant)
 end
 --- Alias for the `Level.GetStage` method.
 function ____exports.getStage(self)

package/functions/trinkets.lua

@@ -76,7 +76,7 @@ function ____exports.getOpenTrinketSlot(self, player)
         end
         return trinketType2 == TrinketType.NULL and 1 or nil
     end
-    return error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
+    error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
 end
 --- Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
 -- trinket type was not valid.

package/index.d.ts

@@ -121,11 +121,7 @@ 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";
-export * from "./interfaces/JSONRooms";
-export * from "./interfaces/JSONSpawn";
+export * from "./interfaces/JSONRoomsFile";
 export * from "./interfaces/PlayerHealth";
 export * from "./interfaces/PocketItemDescription";
 export * from "./interfaces/SaveData";

package/initCustomCallbacks.lua

@@ -11,6 +11,8 @@ local ____postBombInitLate = require("callbacks.postBombInitLate")
 local postBombInitLateInit = ____postBombInitLate.postBombInitLateInit
 local ____postBoneSwing = require("callbacks.postBoneSwing")
 local postBoneSwingInit = ____postBoneSwing.postBoneSwingInit
+local ____postCollectibleEmpty = require("callbacks.postCollectibleEmpty")
+local postCollectibleEmptyInit = ____postCollectibleEmpty.postCollectibleEmptyInit
 local ____postCollectibleInitFirst = require("callbacks.postCollectibleInitFirst")
 local postCollectibleInitFirstInit = ____postCollectibleInitFirst.postCollectibleInitFirstInit
 local ____postCursedTeleport = require("callbacks.postCursedTeleport")
@@ -134,6 +136,7 @@ function ____exports.initCustomCallbacks(self, mod)
     postBombExplodedInit(nil, mod)
     postBombInitLateInit(nil, mod)
     postBoneSwingInit(nil, mod)
+    postCollectibleEmptyInit(nil, mod)
     postCollectibleInitFirstInit(nil, mod)
     postCursedTeleportInit(nil, mod)
     postCustomDoorEnterInit(nil)

package/initFeatures.lua

@@ -7,6 +7,8 @@ local ____collectibleItemPoolType = require("features.collectibleItemPoolType")
 local collectibleItemPoolTypeInit = ____collectibleItemPoolType.collectibleItemPoolTypeInit
 local ____customGridEntity = require("features.customGridEntity")
 local customGridEntityInit = ____customGridEntity.customGridEntityInit
+local ____init = require("features.customStage.init")
+local customStageInit = ____init.customStageInit
 local ____deployJSONRoom = require("features.deployJSONRoom")
 local deployJSONRoomInit = ____deployJSONRoom.deployJSONRoomInit
 local ____disableAllSound = require("features.disableAllSound")
@@ -40,6 +42,7 @@ local stageHistoryInit = ____stageHistory.stageHistoryInit
 local ____taintedLazarusPlayers = require("features.taintedLazarusPlayers")
 local taintedLazarusPlayersInit = ____taintedLazarusPlayers.taintedLazarusPlayersInit
 function ____exports.initFeaturesMajor(self, mod)
+    customStageInit(nil)
     deployJSONRoomInit(nil, mod)
     runInNFramesInit(nil, mod)
     characterStatsInit(nil, mod)

package/interfaces/AddCallbackParameterCustom.d.ts

@@ -3,6 +3,7 @@ import { PostAmbushStartedRegisterParameters } from "../callbacks/subscriptions/
 import { PostBombInitRegisterParameters } from "../callbacks/subscriptions/postBombInitLate";
 import { PostBombExplodedRegisterParameters } from "../callbacks/subscriptions/postBoneExploded";
 import { PostBoneSwingRegisterParameters } from "../callbacks/subscriptions/postBoneSwing";
+import { PostCollectibleEmptyRegisterParameters } from "../callbacks/subscriptions/postCollectibleEmpty";
 import { PostCollectibleInitFirstRegisterParameters } from "../callbacks/subscriptions/postCollectibleInitFirst";
 import { PostCursedTeleportRegisterParameters } from "../callbacks/subscriptions/postCursedTeleport";
 import { PostCustomDoorEnterRegisterParameters } from "../callbacks/subscriptions/postCustomDoorEnter";
@@ -87,6 +88,7 @@ export interface AddCallbackParameterCustom {
     [ModCallbackCustom.POST_BOMB_EXPLODED]: PostBombExplodedRegisterParameters;
     [ModCallbackCustom.POST_BOMB_INIT_LATE]: PostBombInitRegisterParameters;
     [ModCallbackCustom.POST_BONE_SWING]: PostBoneSwingRegisterParameters;
+    [ModCallbackCustom.POST_COLLECTIBLE_EMPTY]: PostCollectibleEmptyRegisterParameters;
     [ModCallbackCustom.POST_COLLECTIBLE_INIT_FIRST]: PostCollectibleInitFirstRegisterParameters;
     [ModCallbackCustom.POST_CURSED_TELEPORT]: PostCursedTeleportRegisterParameters;
     [ModCallbackCustom.POST_CUSTOM_DOOR_ENTER]: PostCustomDoorEnterRegisterParameters;

package/interfaces/CustomStage.d.ts

@@ -0,0 +1,10 @@
+import { DoorSlotFlag, RoomShape, RoomType } from "isaac-typescript-definitions";
+import { CustomStageLua, CustomStageRoomMetadata } from "./CustomStageLua";
+export interface CustomStage extends CustomStageLua {
+    /** A map that makes it easier to select certain room type/shape/door combinations. */
+    readonly roomTypeMap: RoomTypeMap;
+}
+export declare type RoomTypeMap = ReadonlyMap<RoomType, RoomShapeMap>;
+declare type RoomShapeMap = ReadonlyMap<RoomShape, RoomDoorSlotMap>;
+declare type RoomDoorSlotMap = ReadonlyMap<DoorSlotFlag, CustomStageRoomMetadata[]>;
+export {};