isaacscript-common 1.2.227 → 1.2.228

package/dist/constants.d.ts

@@ -37,6 +37,7 @@ export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: number;
 export declare const GAME_FRAMES_PER_SECOND = 30;
 export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
 export declare const ISAAC_FRAMES_PER_SECOND = 60;
+export declare const LEVEL_GRID_COLUMN_HEIGHT = 13;
 export declare const LEVEL_GRID_ROW_LENGTH = 13;
 /** In a 2x2 room, there can be 8 doors. */
 export declare const MAX_NUM_DOORS = 8;

package/dist/constants.lua

@@ -13,6 +13,7 @@ ____exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (1 << 32) - 1
 ____exports.GAME_FRAMES_PER_SECOND = 30
 ____exports.GRID_INDEX_CENTER_OF_1X1_ROOM = 67
 ____exports.ISAAC_FRAMES_PER_SECOND = 60
+____exports.LEVEL_GRID_COLUMN_HEIGHT = 13
 ____exports.LEVEL_GRID_ROW_LENGTH = 13
 ____exports.MAX_NUM_DOORS = 8
 ____exports.MAX_NUM_FAMILIARS = 64

package/dist/functions/roomShape.d.ts

@@ -6,5 +6,36 @@
  * started.
  */
 export declare function getGridIndexDelta(roomShape: RoomShape, doorSlot: DoorSlot): int | undefined;
+/**
+ * Helper function to get the grid position of the bottom-right tile of a given room shape.
+ *
+ * "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 getRoomShapeBottomRightPosition(roomShape: RoomShape): Vector;
+/**
+ * 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.
+ */
+export declare function getRoomShapeBounds(roomShape: RoomShape): Vector;
+/**
+ * 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.
+ *
+ * For example, a horizontal narrow room has a layout size of equal to that of a 1x1 room.
+ */
+export declare function getRoomShapeLayoutSize(roomShape: RoomShape): Vector;
+/**
+ * Helper function to get the grid position of the top-left tile of a given room shape.
+ *
+ * "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;
+/**
+ * Helper function to get the volume of a room shape, which is the amount of tiles that are inside
+ * the room.
+ *
+ * (This cannot be directly calculated from the bounds since L rooms are a special case.)
+ */
+export declare function getRoomShapeVolume(roomShape: RoomShape): int;

package/dist/functions/roomShape.lua

@@ -1,12 +1,18 @@
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local ____exports = {}
+local ____roomShapeBounds = require("objects.roomShapeBounds")
+local ROOM_SHAPE_BOUNDS = ____roomShapeBounds.ROOM_SHAPE_BOUNDS
+local ____roomShapeLayoutSizes = require("objects.roomShapeLayoutSizes")
+local ROOM_SHAPE_LAYOUT_SIZES = ____roomShapeLayoutSizes.ROOM_SHAPE_LAYOUT_SIZES
 local ____roomShapeToBottomRightPosition = require("objects.roomShapeToBottomRightPosition")
 local ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = ____roomShapeToBottomRightPosition.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION
 local ____roomShapeToGridIndexDelta = require("objects.roomShapeToGridIndexDelta")
 local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
 local ____roomShapeToTopLeftPosition = require("objects.roomShapeToTopLeftPosition")
 local ROOM_SHAPE_TO_TOP_LEFT_POSITION = ____roomShapeToTopLeftPosition.ROOM_SHAPE_TO_TOP_LEFT_POSITION
+local ____roomShapeVolumes = require("objects.roomShapeVolumes")
+local ROOM_SHAPE_VOLUMES = ____roomShapeVolumes.ROOM_SHAPE_VOLUMES
 function ____exports.getGridIndexDelta(self, roomShape, doorSlot)
     local doorSlotToGridIndexMap = ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
     if doorSlotToGridIndexMap == nil then
@@ -17,7 +23,16 @@ end
 function ____exports.getRoomShapeBottomRightPosition(self, roomShape)
     return ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION[roomShape]
 end
+function ____exports.getRoomShapeBounds(self, roomShape)
+    return ROOM_SHAPE_BOUNDS[roomShape]
+end
+function ____exports.getRoomShapeLayoutSize(self, roomShape)
+    return ROOM_SHAPE_LAYOUT_SIZES[roomShape]
+end
 function ____exports.getRoomShapeTopLeftPosition(self, roomShape)
     return ROOM_SHAPE_TO_TOP_LEFT_POSITION[roomShape]
 end
+function ____exports.getRoomShapeVolume(self, roomShape)
+    return ROOM_SHAPE_VOLUMES[roomShape]
+end
 return ____exports

package/dist/objects/roomShapeBounds.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * The size of a room shape's contents. This does not include the tiles that the walls are on. L
+ * rooms use the same bounds as a 2x2 room.
+ */
+export declare const ROOM_SHAPE_BOUNDS: {
+    readonly [key in RoomShape]: Vector;
+};

package/dist/objects/roomShapeBounds.lua

@@ -0,0 +1,24 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local ____roomShapeVolumes = require("objects.roomShapeVolumes")
+local NARROW_CONTENTS_HEIGHT = ____roomShapeVolumes.NARROW_CONTENTS_HEIGHT
+local NARROW_CONTENTS_WIDTH = ____roomShapeVolumes.NARROW_CONTENTS_WIDTH
+local ONE_BY_ONE_CONTENTS_HEIGHT = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_HEIGHT
+local ONE_BY_ONE_CONTENTS_WIDTH = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_WIDTH
+local TWO_BY_TWO_BOUNDS = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
+____exports.ROOM_SHAPE_BOUNDS = {
+    [RoomShape.ROOMSHAPE_1x1] = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT),
+    [RoomShape.ROOMSHAPE_IH] = Vector(ONE_BY_ONE_CONTENTS_WIDTH, NARROW_CONTENTS_HEIGHT),
+    [RoomShape.ROOMSHAPE_IV] = Vector(NARROW_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT),
+    [RoomShape.ROOMSHAPE_1x2] = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2),
+    [RoomShape.ROOMSHAPE_IIV] = Vector(NARROW_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2),
+    [RoomShape.ROOMSHAPE_2x1] = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT),
+    [RoomShape.ROOMSHAPE_IIH] = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, NARROW_CONTENTS_HEIGHT),
+    [RoomShape.ROOMSHAPE_2x2] = TWO_BY_TWO_BOUNDS,
+    [RoomShape.ROOMSHAPE_LTL] = TWO_BY_TWO_BOUNDS,
+    [RoomShape.ROOMSHAPE_LTR] = TWO_BY_TWO_BOUNDS,
+    [RoomShape.ROOMSHAPE_LBL] = TWO_BY_TWO_BOUNDS,
+    [RoomShape.ROOMSHAPE_LBR] = TWO_BY_TWO_BOUNDS,
+    [RoomShape.NUM_ROOMSHAPES] = Vector.Zero
+}
+return ____exports

package/dist/objects/roomShapeLayoutSizes.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * The dimensions of a room shape's layout. This is NOT the size of the room's actual contents! For
+ * that, use `ROOM_SHAPE_BOUNDS`.
+ *
+ * For example, a horizontal narrow room has a layout size of equal to that of a 1x1 room.
+ */
+export declare const ROOM_SHAPE_LAYOUT_SIZES: {
+    readonly [key in RoomShape]: Vector;
+};

package/dist/objects/roomShapeLayoutSizes.lua

@@ -0,0 +1,25 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local ____roomShapeVolumes = require("objects.roomShapeVolumes")
+local ONE_BY_ONE_CONTENTS_HEIGHT = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_HEIGHT
+local ONE_BY_ONE_CONTENTS_WIDTH = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_WIDTH
+local ONE_BY_ONE_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT)
+local TWO_BY_ONE_VERTICAL_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
+local TWO_BY_ONE_HORIZONTAL_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT)
+local TWO_BY_TWO_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
+____exports.ROOM_SHAPE_LAYOUT_SIZES = {
+    [RoomShape.ROOMSHAPE_1x1] = ONE_BY_ONE_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_IH] = ONE_BY_ONE_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_IV] = ONE_BY_ONE_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_1x2] = TWO_BY_ONE_VERTICAL_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_IIV] = TWO_BY_ONE_VERTICAL_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_2x1] = TWO_BY_ONE_HORIZONTAL_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_IIH] = TWO_BY_ONE_HORIZONTAL_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_2x2] = TWO_BY_TWO_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_LTL] = TWO_BY_TWO_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_LTR] = TWO_BY_TWO_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_LBL] = TWO_BY_TWO_LAYOUT_SIZE,
+    [RoomShape.ROOMSHAPE_LBR] = TWO_BY_TWO_LAYOUT_SIZE,
+    [RoomShape.NUM_ROOMSHAPES] = TWO_BY_TWO_LAYOUT_SIZE
+}
+return ____exports

package/dist/objects/roomShapeVolumes.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare const ONE_BY_ONE_CONTENTS_WIDTH = 13;
+export declare const ONE_BY_ONE_CONTENTS_HEIGHT = 7;
+export declare const NARROW_CONTENTS_WIDTH = 5;
+export declare const NARROW_CONTENTS_HEIGHT = 3;
+/**
+ * Volume is the amount of tiles that are inside the room shape.
+ *
+ * (This cannot be directly calculated from the bounds since L rooms are a special case.)
+ */
+export declare const ROOM_SHAPE_VOLUMES: {
+    readonly [key in RoomShape]: int;
+};

package/dist/objects/roomShapeVolumes.lua

@@ -0,0 +1,27 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+____exports.ONE_BY_ONE_CONTENTS_WIDTH = 13
+____exports.ONE_BY_ONE_CONTENTS_HEIGHT = 7
+local ONE_BY_ONE_VOLUME = ____exports.ONE_BY_ONE_CONTENTS_HEIGHT * ____exports.ONE_BY_ONE_CONTENTS_WIDTH
+____exports.NARROW_CONTENTS_WIDTH = 5
+____exports.NARROW_CONTENTS_HEIGHT = 3
+local NARROW_HORIZONTAL_VOLUME = ____exports.ONE_BY_ONE_CONTENTS_WIDTH * ____exports.NARROW_CONTENTS_HEIGHT
+local NARROW_VERTICAL_VOLUME = ____exports.NARROW_CONTENTS_WIDTH * ____exports.ONE_BY_ONE_CONTENTS_HEIGHT
+local ONE_BY_TWO_VOLUME = ONE_BY_ONE_VOLUME * 2
+local L_ROOM_VOLUME = ONE_BY_ONE_VOLUME * 3
+____exports.ROOM_SHAPE_VOLUMES = {
+    [RoomShape.ROOMSHAPE_1x1] = ONE_BY_ONE_VOLUME,
+    [RoomShape.ROOMSHAPE_IH] = NARROW_HORIZONTAL_VOLUME,
+    [RoomShape.ROOMSHAPE_IV] = NARROW_VERTICAL_VOLUME,
+    [RoomShape.ROOMSHAPE_1x2] = ONE_BY_TWO_VOLUME,
+    [RoomShape.ROOMSHAPE_IIV] = NARROW_VERTICAL_VOLUME * 2,
+    [RoomShape.ROOMSHAPE_2x1] = ONE_BY_TWO_VOLUME,
+    [RoomShape.ROOMSHAPE_IIH] = NARROW_HORIZONTAL_VOLUME * 2,
+    [RoomShape.ROOMSHAPE_2x2] = ONE_BY_ONE_VOLUME * 4,
+    [RoomShape.ROOMSHAPE_LTL] = L_ROOM_VOLUME,
+    [RoomShape.ROOMSHAPE_LTR] = L_ROOM_VOLUME,
+    [RoomShape.ROOMSHAPE_LBL] = L_ROOM_VOLUME,
+    [RoomShape.ROOMSHAPE_LBR] = L_ROOM_VOLUME,
+    [RoomShape.NUM_ROOMSHAPES] = 0
+}
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.227",
+  "version": "1.2.228",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",