isaacscript-common 9.16.0 → 9.16.1

package/dist/functions/levelGrid.d.ts

@@ -53,7 +53,8 @@ export declare function getAllRoomGridIndexes(): int[];
 export declare function getNewRoomCandidate(seedOrRNG?: Seed | RNG): [adjacentRoomGridIndex: int, doorSlot: DoorSlot, newRoomGridIndex: int] | undefined;
 /**
  * Helper function to iterate through the possible doors for a room and see if any of them would be
- * a valid spot to insert a brand new room on the floor.
+ * a valid spot to insert a brand new room on the floor. (Any potential new rooms cannot be
+ * connected to any other existing rooms on the floor.)
  *
  * @param roomGridIndex Optional. Default is the current room index.
  * @returns A array of tuples of `DoorSlot` and room grid index.
@@ -63,7 +64,8 @@ export declare function getNewRoomCandidatesBesideRoom(roomGridIndex?: int): Arr
  * Helper function to search through all of the rooms on the floor for a spot to insert a brand new
  * room.
  *
- * @returns A array of tuples of adjacent room grid index, `DoorSlot`, and new room grid index.
+ * @returns A array of tuples containing the adjacent room grid index, the `DoorSlot`, and the new
+ *          room grid index.
  */
 export declare function getNewRoomCandidatesForLevel(): Array<[
     adjacentRoomGridIndex: int,

package/dist/functions/levelGrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"levelGrid.d.ts","sourceRoot":"","sources":["../../src/functions/levelGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEL,QAAQ,EAKR,SAAS,EACT,QAAQ,EACT,MAAM,8BAA8B,CAAC;AA8BtC;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAK7E;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,CACnD,aAAa,CAAC,EAAE,GAAG,GAClB,GAAG,EAAE,CAKP;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,0BAA0B,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAerE;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,IAAI,GAAG,EAAE,CAG7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,GAErC,CAAC,qBAAqB,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,CAAC,GACvE,SAAS,CAOZ;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,CAAC,EAAE,GAAG,GAClB,KAAK,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC,CA0CjD;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,IAAI,KAAK,CACnD;IAAC,qBAAqB,EAAE,GAAG;IAAE,QAAQ,EAAE,QAAQ;IAAE,gBAAgB,EAAE,GAAG;CAAC,CACxE,CAsBA;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAgBpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,EAAE,CAWzE;AAED;;;;;;GAMG;AACH,wBAAgB,uCAAuC,CACrD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAiBpB;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAEpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC7C,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAapB;AAED;;;;;;GAMG;AACH,wBAAgB,0CAA0C,CACxD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAiBpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAKtD;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAGT;AAED,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAqBT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAGzD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAM7D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,SAAS,CAmD/D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,GAAG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAKtE"}
+{"version":3,"file":"levelGrid.d.ts","sourceRoot":"","sources":["../../src/functions/levelGrid.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEL,QAAQ,EAKR,SAAS,EACT,QAAQ,EACT,MAAM,8BAA8B,CAAC;AA8BtC;;;;;GAKG;AACH,wBAAgB,kCAAkC,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAK7E;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,CACnD,aAAa,CAAC,EAAE,GAAG,GAClB,GAAG,EAAE,CAKP;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,0BAA0B,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE,CAerE;AAED,0FAA0F;AAC1F,wBAAgB,qBAAqB,IAAI,GAAG,EAAE,CAG7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,GAErC,CAAC,qBAAqB,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,CAAC,GACvE,SAAS,CAOZ;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAC5C,aAAa,CAAC,EAAE,GAAG,GAClB,KAAK,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC,CA8CjD;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,IAAI,KAAK,CACnD;IAAC,qBAAqB,EAAE,GAAG;IAAE,QAAQ,EAAE,QAAQ;IAAE,gBAAgB,EAAE,GAAG;CAAC,CACxE,CA2BA;AAED;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAgBpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,EAAE,CAWzE;AAED;;;;;;GAMG;AACH,wBAAgB,uCAAuC,CACrD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAiBpB;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CACjD,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAEpB;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAC7C,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAapB;AAED;;;;;;GAMG;AACH,wBAAgB,0CAA0C,CACxD,iBAAiB,EAAE,GAAG,EACtB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAiBpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAKtD;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAGT;AAED,wBAAgB,oCAAoC,CAClD,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,GAAG,GACjB,OAAO,CAqBT;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAGzD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,CAM7D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,SAAS,CAmD/D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,aAAa,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,GAAG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAKtE"}

package/dist/functions/levelGrid.lua

@@ -47,16 +47,15 @@ local ____roomShape = require("functions.roomShape")
 local getGridIndexDelta = ____roomShape.getGridIndexDelta
 local ____types = require("functions.types")
 local asNumber = ____types.asNumber
---- Helper function to get only the adjacent room grid indexes that do not exist (i.e. do not have
--- room data).
+--- Helper function to get only the adjacent room grid indexes that exist (i.e. have room data).
 -- 
 -- This is just a filtering of the results of the `getAdjacentExistingRoomGridIndexes` function. See
 -- that function for more information.
-function ____exports.getAdjacentNonExistingRoomGridIndexes(self, roomGridIndex)
+function ____exports.getAdjacentExistingRoomGridIndexes(self, roomGridIndex)
     local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
     return __TS__ArrayFilter(
         adjacentRoomGridIndexes,
-        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) == nil end
+        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) ~= nil end
     )
 end
 --- Helper function to get all of the room grid indexes that are adjacent to a given room grid index
@@ -87,7 +86,8 @@ function ____exports.getAdjacentRoomGridIndexes(self, roomGridIndex)
     )
 end
 --- Helper function to iterate through the possible doors for a room and see if any of them would be
--- a valid spot to insert a brand new room on the floor.
+-- a valid spot to insert a brand new room on the floor. (Any potential new rooms cannot be
+-- connected to any other existing rooms on the floor.)
 -- 
 -- @param roomGridIndex Optional. Default is the current room index.
 -- @returns A array of tuples of `DoorSlot` and room grid index.
@@ -122,7 +122,8 @@ end
 --- Helper function to search through all of the rooms on the floor for a spot to insert a brand new
 -- room.
 -- 
--- @returns A array of tuples of adjacent room grid index, `DoorSlot`, and new room grid index.
+-- @returns A array of tuples containing the adjacent room grid index, the `DoorSlot`, and the new
+-- room grid index.
 function ____exports.getNewRoomCandidatesForLevel(self)
     local rooms = getRoomsInsideGrid(nil)
     local normalRooms = __TS__ArrayFilter(
@@ -214,8 +215,8 @@ end
 -- 
 -- @param roomGridIndex Optional. Default is the current room index.
 function ____exports.isDeadEnd(self, roomGridIndex)
-    local adjacentNonExistingRoomGridIndexes = ____exports.getAdjacentNonExistingRoomGridIndexes(nil, roomGridIndex)
-    return #adjacentNonExistingRoomGridIndexes == 1
+    local adjacentExistingRoomGridIndexes = ____exports.getAdjacentExistingRoomGridIndexes(nil, roomGridIndex)
+    return #adjacentExistingRoomGridIndexes == 1
 end
 --- Helper function to determine if a given room grid index is inside of the normal 13x13 level grid.
 -- 
@@ -239,15 +240,16 @@ local UP = -LEVEL_GRID_ROW_WIDTH
 local RIGHT = 1
 local DOWN = LEVEL_GRID_ROW_WIDTH
 ADJACENT_ROOM_GRID_INDEX_DELTAS = {LEFT, UP, RIGHT, DOWN}
---- Helper function to get only the adjacent room grid indexes that exist (i.e. have room data).
+--- Helper function to get only the adjacent room grid indexes that do not exist (i.e. do not have
+-- room data).
 -- 
 -- This is just a filtering of the results of the `getAdjacentExistingRoomGridIndexes` function. See
 -- that function for more information.
-function ____exports.getAdjacentExistingRoomGridIndexes(self, roomGridIndex)
+function ____exports.getAdjacentNonExistingRoomGridIndexes(self, roomGridIndex)
     local adjacentRoomGridIndexes = ____exports.getAdjacentRoomGridIndexes(nil, roomGridIndex)
     return __TS__ArrayFilter(
         adjacentRoomGridIndexes,
-        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) ~= nil end
+        function(____, adjacentRoomGridIndex) return getRoomData(nil, adjacentRoomGridIndex) == nil end
     )
 end
 --- Helper function to get the room safe grid index for every room on the entire floor.

package/dist/index.d.ts

@@ -3667,7 +3667,8 @@ export declare function getNewRoomCandidate(seedOrRNG?: Seed | RNG): [adjacentRo
 
 /**
  * Helper function to iterate through the possible doors for a room and see if any of them would be
- * a valid spot to insert a brand new room on the floor.
+ * a valid spot to insert a brand new room on the floor. (Any potential new rooms cannot be
+ * connected to any other existing rooms on the floor.)
  *
  * @param roomGridIndex Optional. Default is the current room index.
  * @returns A array of tuples of `DoorSlot` and room grid index.
@@ -3678,7 +3679,8 @@ export declare function getNewRoomCandidatesBesideRoom(roomGridIndex?: int): Arr
  * Helper function to search through all of the rooms on the floor for a spot to insert a brand new
  * room.
  *
- * @returns A array of tuples of adjacent room grid index, `DoorSlot`, and new room grid index.
+ * @returns A array of tuples containing the adjacent room grid index, the `DoorSlot`, and the new
+ *          room grid index.
  */
 export declare function getNewRoomCandidatesForLevel(): Array<[
 adjacentRoomGridIndex: int,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "9.16.0",
+  "version": "9.16.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/levelGrid.ts

@@ -138,7 +138,8 @@ export function getNewRoomCandidate(
 
 /**
  * Helper function to iterate through the possible doors for a room and see if any of them would be
- * a valid spot to insert a brand new room on the floor.
+ * a valid spot to insert a brand new room on the floor. (Any potential new rooms cannot be
+ * connected to any other existing rooms on the floor.)
  *
  * @param roomGridIndex Optional. Default is the current room index.
  * @returns A array of tuples of `DoorSlot` and room grid index.
@@ -148,10 +149,14 @@ export function getNewRoomCandidatesBesideRoom(
 ): Array<[doorSlot: DoorSlot, roomGridIndex: int]> {
   const roomDescriptor = getRoomDescriptor(roomGridIndex);
 
+  // First, handle the case of rooms outside of the grid, which obviously cannot have any possible
+  // adjacent new room candidates.
   if (!isRoomInsideGrid(roomDescriptor.SafeGridIndex)) {
     return [];
   }
 
+  // Rooms without data are non-existent, so they obviously cannot have any possible adjacent new
+  // room candidates.
   const roomData = roomDescriptor.Data;
   if (roomData === undefined) {
     return [];
@@ -193,16 +198,22 @@ export function getNewRoomCandidatesBesideRoom(
  * Helper function to search through all of the rooms on the floor for a spot to insert a brand new
  * room.
  *
- * @returns A array of tuples of adjacent room grid index, `DoorSlot`, and new room grid index.
+ * @returns A array of tuples containing the adjacent room grid index, the `DoorSlot`, and the new
+ *          room grid index.
  */
 export function getNewRoomCandidatesForLevel(): Array<
   [adjacentRoomGridIndex: int, doorSlot: DoorSlot, newRoomGridIndex: int]
 > {
+  // We want to iterate over every room on the floor and search for potential new room spots.
   const rooms = getRoomsInsideGrid();
+
+  // However, we want to filter out special rooms because they are supposed to be dead ends.
   const normalRooms = rooms.filter(
     (room) =>
       room.Data !== undefined &&
       room.Data.Type === RoomType.DEFAULT &&
+      // The mirror room and the mineshaft entrance count as normal rooms, but those are supposed to
+      // be dead ends as well.
       room.Data.Subtype !== asNumber(DownpourRoomSubType.MIRROR) &&
       room.Data.Subtype !== asNumber(MinesRoomSubType.MINESHAFT_ENTRANCE),
   );
@@ -385,10 +396,10 @@ export function getRoomShapeAdjacentNonExistingGridIndexes(
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export function isDeadEnd(roomGridIndex?: int): boolean {
-  const adjacentNonExistingRoomGridIndexes =
-    getAdjacentNonExistingRoomGridIndexes(roomGridIndex);
+  const adjacentExistingRoomGridIndexes =
+    getAdjacentExistingRoomGridIndexes(roomGridIndex);
 
-  return adjacentNonExistingRoomGridIndexes.length === 1;
+  return adjacentExistingRoomGridIndexes.length === 1;
 }
 
 export function isDoorSlotValidAtGridIndex(