isaacscript-common 55.1.0 → 55.2.0

package/src/functions/logMisc.ts

@@ -22,7 +22,7 @@ import { getEntityID } from "./entities";
 import { getEnumEntries } from "./enums";
 import { hasFlag } from "./flag";
 import { getIsaacAPIClassName } from "./isaacAPIClass";
-import { log, logAndPrint } from "./log";
+import { log } from "./log";
 import { getPlayerHealth } from "./playerHealth";
 import { getEffectsList, getPlayerName } from "./players";
 import { getRoomData, getRoomGridIndex, getRoomListIndex } from "./roomData";
@@ -128,17 +128,6 @@ export function logEntityID(this: void, entity: Entity): void {
   log(`Logging entity: ${entityID}`);
 }
 
-/**
- * Helper function to log an error message and also print it to the console for better visibility.
- *
- * This is useful in situations where using the `error` function would be dangerous (since it
- * prevents all of the subsequent code in the callback from running).
- */
-export function logError(this: void, msg: string): void {
-  const errorMsg = `Error: ${msg}`;
-  logAndPrint(errorMsg);
-}
-
 /** Helper function for logging every flag that is turned on. Useful when debugging. */
 export function logFlags<T extends BitFlag | BitFlag128>(
   this: void,

package/src/functions/rng.ts

@@ -2,6 +2,7 @@ import type { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
+import { logError } from "./log";
 import { getNumbersFromTable, tableHasKeys } from "./table";
 import { isTable } from "./types";
 import { assertDefined } from "./utils";
@@ -155,8 +156,9 @@ export function setAllRNGToStartSeed(object: unknown): void {
 /** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
 export function setSeed(rng: RNG, seed: Seed): void {
   if (seed === 0) {
-    error(
-      "You cannot set an RNG object to a seed of 0, or the game will crash.",
+    seed = getRandomSeed();
+    logError(
+      "Failed to set a RNG object to a seed of 0. Using a random value instead.",
     );
   }
 

package/src/functions/roomShape.ts

@@ -10,6 +10,7 @@ import { ROOM_SHAPE_TO_GRID_WIDTH } from "../objects/roomShapeToGridWidth";
 import { ROOM_SHAPE_TO_TOP_LEFT_POSITION } from "../objects/roomShapeToTopLeftPosition";
 import { ROOM_SHAPE_VOLUMES } from "../objects/roomShapeVolumes";
 import { L_ROOM_SHAPES_SET } from "../sets/LRoomShapesSet";
+import { BIG_ROOM_SHAPES_SET } from "../sets/bigRoomShapesSet";
 import { NARROW_ROOM_SHAPES_SET } from "../sets/narrowRoomShapesSet";
 
 /**
@@ -109,6 +110,14 @@ export function getRoomShapeWidth(roomShape: RoomShape): int {
   return ROOM_SHAPE_TO_GRID_WIDTH[roomShape];
 }
 
+/**
+ * Helper function to detect if the provided room shape is big. Specifically, this is all 1x2 rooms,
+ * 2x2 rooms, and L rooms.
+ */
+export function isBigRoomShape(roomShape: RoomShape): boolean {
+  return BIG_ROOM_SHAPES_SET.has(roomShape);
+}
+
 export function isLRoomShape(roomShape: RoomShape): boolean {
   return L_ROOM_SHAPES_SET.has(roomShape);
 }

package/src/functions/rooms.ts

@@ -45,7 +45,7 @@ import {
   getRoomDescriptorReadOnly,
   getRoomGridIndex,
 } from "./roomData";
-import { isLRoomShape } from "./roomShape";
+import { isBigRoomShape, isLRoomShape } from "./roomShape";
 import { reloadRoom } from "./roomTransition";
 import { getGotoCommand } from "./stage";
 import { asNumber } from "./types";
@@ -318,6 +318,15 @@ export function inBeastRoom(): boolean {
   return isBeastRoom(roomData);
 }
 
+/**
+ * Helper function to detect if the current room is big. Specifically, this is all 1x2 rooms, 2x2
+ * rooms, and L rooms.
+ */
+export function inBigRoom(): boolean {
+  const roomData = getRoomData();
+  return isBigRoom(roomData);
+}
+
 /**
  * Helper function to check if the current room is the Boss Room for a particular boss. This will
  * only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.
@@ -601,6 +610,14 @@ export function isBeastRoom(roomData: RoomConfig): boolean {
   );
 }
 
+/**
+ * Helper function to detect if the provided room is big. Specifically, this is all 1x2 rooms, 2x2
+ * rooms, and L rooms.
+ */
+export function isBigRoom(roomData: RoomConfig): boolean {
+  return isBigRoomShape(roomData.Shape);
+}
+
 /**
  * Helper function to check if the provided room is the Boss Room for a particular boss. This will
  * only work for bosses that have dedicated boss rooms in the "00.special rooms.stb" file.

package/src/functions/stage.ts

@@ -181,7 +181,14 @@ export function getStageType(): StageType {
   return level.GetStageType();
 }
 
-/** Helper function to directly warp to a specific stage using the "stage" console command. */
+/**
+ * Helper function to directly warp to a specific stage using the "stage" console command.
+ *
+ * Note that if you use this function on game frame 0, it will confuse the
+ * `POST_GAME_STARTED_REORDERED`, `POST_NEW_LEVEL_REORDERED`, and `POST_NEW_ROOM_REORDERED` custom
+ * callbacks. If you are using the function in this situation, remember to call the
+ * `reorderedCallbacksSetStage` function.
+ */
 export function goToStage(stage: LevelStage, stageType: StageType): void {
   const stageTypeLetterSuffix = stageTypeToLetter(stageType);
   const command = `stage ${stage}${stageTypeLetterSuffix}`;

package/src/sets/bigRoomShapesSet.ts

@@ -0,0 +1,12 @@
+import { RoomShape } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
+
+export const BIG_ROOM_SHAPES_SET = new ReadonlySet<RoomShape>([
+  RoomShape.SHAPE_1x2, // 4
+  RoomShape.SHAPE_2x1, // 6
+  RoomShape.SHAPE_2x2, // 8
+  RoomShape.LTL, // 9
+  RoomShape.LTR, // 10
+  RoomShape.LBL, // 11
+  RoomShape.LBR, // 12
+]);