isaacscript-common 5.0.3 → 5.1.0

package/functions/array.d.ts

@@ -63,6 +63,7 @@ export declare function emptyArray<T>(array: T[]): void;
  * For example, if this function is provided an array containing 1, 2, and 3, then it will return an
  * array containing the following arrays:
  *
+ * - [] (if `includeEmptyArray` is set to true)
  * - [1]
  * - [2]
  * - [3]

package/functions/array.lua

@@ -225,6 +225,7 @@ end
 -- For example, if this function is provided an array containing 1, 2, and 3, then it will return an
 -- array containing the following arrays:
 -- 
+-- - [] (if `includeEmptyArray` is set to true)
 -- - [1]
 -- - [2]
 -- - [3]

package/functions/doors.d.ts

@@ -53,6 +53,11 @@ export declare function getDoors(...roomTypes: RoomType[]): GridEntityDoor[];
 export declare function getDoorsToRoomIndex(...roomGridIndex: int[]): GridEntityDoor[];
 export declare function getOppositeDoorSlot(doorSlot: DoorSlot): DoorSlot | undefined;
 export declare function getRepentanceDoor(): GridEntityDoor | undefined;
+/**
+ * Helper function to get the room grid coordinates for a specific room shape and door slot
+ * combination.
+ */
+export declare function getRoomShapeDoorSlotCoordinates(roomShape: RoomShape, doorSlot: DoorSlot): readonly [x: int, y: int] | undefined;
 /** Helper function to find unused door slots in the room that can be used to make custom doors. */
 export declare function getUnusedDoorSlots(): DoorSlot[];
 export declare function isAngelRoomDoor(door: GridEntityDoor): boolean;

package/functions/doors.lua

@@ -24,6 +24,8 @@ local ____doorSlotToDoorSlotFlag = require("objects.doorSlotToDoorSlotFlag")
 local DOOR_SLOT_TO_DOOR_SLOT_FLAG = ____doorSlotToDoorSlotFlag.DOOR_SLOT_TO_DOOR_SLOT_FLAG
 local ____oppositeDoorSlots = require("objects.oppositeDoorSlots")
 local OPPOSITE_DOOR_SLOTS = ____oppositeDoorSlots.OPPOSITE_DOOR_SLOTS
+local ____roomShapeToDoorSlotCoordinates = require("objects.roomShapeToDoorSlotCoordinates")
+local ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES = ____roomShapeToDoorSlotCoordinates.ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES
 local ____roomShapeToDoorSlots = require("objects.roomShapeToDoorSlots")
 local ROOM_SHAPE_TO_DOOR_SLOTS = ____roomShapeToDoorSlots.ROOM_SHAPE_TO_DOOR_SLOTS
 local ____bitwise = require("functions.bitwise")
@@ -190,6 +192,12 @@ function ____exports.getRepentanceDoor(self)
         function(____, door) return ____exports.isRepentanceDoor(nil, door) end
     )
 end
+--- Helper function to get the room grid coordinates for a specific room shape and door slot
+-- combination.
+function ____exports.getRoomShapeDoorSlotCoordinates(self, roomShape, doorSlot)
+    local coordinatesMap = ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES[roomShape]
+    return coordinatesMap:get(doorSlot)
+end
 --- Helper function to find unused door slots in the room that can be used to make custom doors.
 function ____exports.getUnusedDoorSlots(self)
     local room = game:GetRoom()

package/functions/set.d.ts

@@ -38,7 +38,7 @@ export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, see
  * For example, if this function is provided a set containing 1, 2, and 3, then it will return an
  * array containing the following sets:
  *
- * - []
+ * - [] (if `includeEmptyArray` is set to true)
  * - [1]
  * - [2]
  * - [3]

package/functions/set.lua

@@ -88,7 +88,7 @@ end
 -- For example, if this function is provided a set containing 1, 2, and 3, then it will return an
 -- array containing the following sets:
 -- 
--- - []
+-- - [] (if `includeEmptyArray` is set to true)
 -- - [1]
 -- - [2]
 -- - [3]

package/objects/roomShapeToDoorSlotCoordinates.d.ts

@@ -1,5 +1,9 @@
+import { DoorSlot, RoomShape } from "isaac-typescript-definitions";
 /**
  * The coordinates correspond to the x and y values that are present in a room's XML file.
  *
  * e.g. `<door exists="False" x="-1" y="3" />`
  */
+export declare const ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES: {
+    readonly [key in RoomShape]: ReadonlyMap<DoorSlot, [x: int, y: int]>;
+};

package/objects/roomShapeToDoorSlotCoordinates.lua

@@ -0,0 +1,84 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+--- The coordinates correspond to the x and y values that are present in a room's XML file.
+-- 
+-- e.g. `<door exists="False" x="-1" y="3" />`
+____exports.ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES = {
+    [RoomShape.SHAPE_1x1] = __TS__New(Map, {{DoorSlot.LEFT_0, {-1, 3}}, {DoorSlot.UP_0, {6, -1}}, {DoorSlot.RIGHT_0, {13, 3}}, {DoorSlot.DOWN_0, {6, 7}}}),
+    [RoomShape.IH] = __TS__New(Map, {{DoorSlot.LEFT_0, {-1, 3}}, {DoorSlot.RIGHT_0, {13, 3}}}),
+    [RoomShape.IV] = __TS__New(Map, {{DoorSlot.UP_0, {6, -1}}, {DoorSlot.DOWN_0, {6, 7}}}),
+    [RoomShape.SHAPE_1x2] = __TS__New(Map, {
+        {DoorSlot.LEFT_0, {-1, 3}},
+        {DoorSlot.UP_0, {6, -1}},
+        {DoorSlot.RIGHT_0, {13, 3}},
+        {DoorSlot.DOWN_0, {6, 14}},
+        {DoorSlot.LEFT_1, {-1, 10}},
+        {DoorSlot.RIGHT_1, {13, 10}}
+    }),
+    [RoomShape.IIV] = __TS__New(Map, {{DoorSlot.UP_0, {6, -1}}, {DoorSlot.DOWN_0, {6, 14}}}),
+    [RoomShape.SHAPE_2x1] = __TS__New(Map, {
+        {DoorSlot.LEFT_0, {-1, 3}},
+        {DoorSlot.UP_0, {6, -1}},
+        {DoorSlot.RIGHT_0, {26, 3}},
+        {DoorSlot.DOWN_0, {6, 7}},
+        {DoorSlot.UP_1, {19, -1}},
+        {DoorSlot.DOWN_1, {19, 7}}
+    }),
+    [RoomShape.IIH] = __TS__New(Map, {{DoorSlot.LEFT_0, {-1, 3}}, {DoorSlot.RIGHT_0, {26, 3}}}),
+    [RoomShape.SHAPE_2x2] = __TS__New(Map, {
+        {DoorSlot.LEFT_0, {-1, 3}},
+        {DoorSlot.UP_0, {6, -1}},
+        {DoorSlot.RIGHT_0, {26, 3}},
+        {DoorSlot.DOWN_0, {6, 14}},
+        {DoorSlot.LEFT_1, {-1, 10}},
+        {DoorSlot.UP_1, {19, -1}},
+        {DoorSlot.RIGHT_1, {26, 10}},
+        {DoorSlot.DOWN_1, {19, 14}}
+    }),
+    [RoomShape.LTL] = __TS__New(Map, {
+        {DoorSlot.LEFT_0, {12, 3}},
+        {DoorSlot.UP_0, {6, 6}},
+        {DoorSlot.RIGHT_0, {26, 3}},
+        {DoorSlot.DOWN_0, {6, 14}},
+        {DoorSlot.LEFT_1, {-1, 10}},
+        {DoorSlot.UP_1, {19, -1}},
+        {DoorSlot.RIGHT_1, {26, 10}},
+        {DoorSlot.DOWN_1, {19, 14}}
+    }),
+    [RoomShape.LTR] = __TS__New(Map, {
+        {DoorSlot.LEFT_0, {-1, 3}},
+        {DoorSlot.UP_0, {6, -1}},
+        {DoorSlot.RIGHT_0, {13, 3}},
+        {DoorSlot.DOWN_0, {6, 14}},
+        {DoorSlot.LEFT_1, {-1, 10}},
+        {DoorSlot.UP_1, {19, 6}},
+        {DoorSlot.RIGHT_1, {26, 10}},
+        {DoorSlot.DOWN_1, {19, 14}}
+    }),
+    [RoomShape.LBL] = __TS__New(Map, {
+        {DoorSlot.LEFT_0, {-1, 3}},
+        {DoorSlot.UP_0, {6, -1}},
+        {DoorSlot.RIGHT_0, {26, 3}},
+        {DoorSlot.DOWN_0, {6, 7}},
+        {DoorSlot.LEFT_1, {12, 10}},
+        {DoorSlot.UP_1, {19, -1}},
+        {DoorSlot.RIGHT_1, {26, 10}},
+        {DoorSlot.DOWN_1, {19, 14}}
+    }),
+    [RoomShape.LBR] = __TS__New(Map, {
+        {DoorSlot.LEFT_0, {-1, 3}},
+        {DoorSlot.UP_0, {6, -1}},
+        {DoorSlot.RIGHT_0, {26, 3}},
+        {DoorSlot.DOWN_0, {6, 14}},
+        {DoorSlot.LEFT_1, {-1, 10}},
+        {DoorSlot.UP_1, {19, -1}},
+        {DoorSlot.RIGHT_1, {13, 10}},
+        {DoorSlot.DOWN_1, {19, 7}}
+    })
+}
+return ____exports

package/package.json

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