isaacscript-common 21.8.4 → 22.0.0

package/dist/src/functions/vector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,MAAM,CAOR;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,QAAQ,CAAC,MAAM,CAAC,CAOlB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}

package/package.json

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

package/src/functions/color.ts

@@ -87,7 +87,7 @@ export function deserializeColor(color: SerializedColor): Color {
 export function getRandomColor(
   seedOrRNG: Seed | RNG = getRandomSeed(),
   alpha = 1,
-): Color {
+): Readonly<Color> {
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
   const r = getRandom(rng);

package/src/functions/hex.ts

@@ -8,7 +8,7 @@ const HEX_STRING_LENGTH = 6;
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
  * @param alpha Optional. Range is from 0 to 1. Default is 1. (The same as the `Color` constructor.)
  */
-export function hexToColor(hexString: string, alpha = 1.0): Color {
+export function hexToColor(hexString: string, alpha = 1.0): Readonly<Color> {
   const [r, g, b] = hexToRGB(hexString);
 
   // Color values should be between 0 and 1.
@@ -22,7 +22,7 @@ export function hexToColor(hexString: string, alpha = 1.0): Color {
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
  * @param alpha Range is from 0 to 1. Default is 1.
  */
-export function hexToKColor(hexString: string, alpha = 1.0): KColor {
+export function hexToKColor(hexString: string, alpha = 1.0): Readonly<KColor> {
   const [r, g, b] = hexToRGB(hexString);
 
   // KColor values should be between 0 and 1.

package/src/functions/kColor.ts

@@ -76,7 +76,7 @@ export function deserializeKColor(kColor: SerializedKColor): KColor {
 export function getRandomKColor(
   seedOrRNG: Seed | RNG = getRandomSeed(),
   alpha = 1,
-): KColor {
+): Readonly<KColor> {
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
   const r = getRandom(rng);

package/src/functions/log.ts

@@ -1,3 +1,5 @@
+import { isNumber } from "./types";
+
 /**
  * Helper function to get the name and the line number of the current calling function.
  *
@@ -53,9 +55,13 @@ export function getParentFunctionDescription(
  */
 export function log(
   this: void,
-  msg: string,
+  msg: string | number,
   includeParentFunction = true,
 ): void {
+  if (isNumber(msg)) {
+    msg = msg.toString();
+  }
+
   const parentFunctionDescription = includeParentFunction
     ? getParentFunctionDescription()
     : undefined;

package/src/functions/minimap.ts

@@ -37,6 +37,18 @@ export function clearFloorDisplayFlags(): void {
   setAllDisplayFlags(DisplayFlagZero);
 }
 
+/**
+ * Helper function to set the value of `DisplayFlag` for a room 0.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ */
+export function clearRoomDisplayFlags(roomGridIndex: int): void {
+  setRoomDisplayFlags(roomGridIndex, DisplayFlagZero);
+}
+
 /**
  * Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
  * that is indexed by the room's safe grid index.
@@ -163,25 +175,21 @@ export function setRoomDisplayFlags(
   } else {
     const minimapAPIRoomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
     if (minimapAPIRoomDescriptor === undefined) {
+      // The room might have already been removed previously.
+      if (displayFlags === DisplayFlagZero) {
+        return;
+      }
+
       error(
         `Failed to get the MinimapAPI room descriptor for the room at index: ${roomGridIndex}`,
       );
     }
     minimapAPIRoomDescriptor.SetDisplayFlags(displayFlags);
-  }
-}
 
-/**
- * Helper function to make a single room visible in a similar way to how the Compass makes a Boss
- * Room visible (e.g. by adding `DisplayFlag.SHOW_ICON`).
- *
- * @param roomGridIndex Set to undefined to use the current room index.
- * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
- *                         make the changes immediately visible. Default is true.
- */
-export function setRoomVisible(
-  roomGridIndex: int | undefined,
-  updateVisibility = true,
-): void {
-  addRoomDisplayFlag(roomGridIndex, DisplayFlag.SHOW_ICON, updateVisibility);
+    // MinimapAPI is bugged such that setting the display flags to 0 does not make the room
+    // invisible. We delete the room to work around this.
+    if (displayFlags === DisplayFlagZero) {
+      minimapAPIRoomDescriptor.Remove();
+    }
+  }
 }

package/src/functions/positionVelocity.ts

@@ -54,7 +54,7 @@ export function findFreePosition(
   startingPosition: Vector,
   avoidActiveEntities = false,
   minimumDistance?: float,
-): Vector {
+): Readonly<Vector> {
   const room = game.GetRoom();
   const heavenDoors = getEffects(
     EffectVariant.HEAVEN_LIGHT_DOOR,

package/src/functions/roomGrid.ts

@@ -22,7 +22,10 @@ import {
  *
  * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
  */
-export function gridCoordinatesToWorldPosition(x: int, y: int): Vector {
+export function gridCoordinatesToWorldPosition(
+  x: int,
+  y: int,
+): Readonly<Vector> {
   const gridPosition = Vector(x, y);
   return gridPositionToWorldPosition(gridPosition);
 }
@@ -36,7 +39,7 @@ export function gridCoordinatesToWorldPosition(x: int, y: int): Vector {
 export function gridIndexToGridPosition(
   gridIndex: int,
   roomShape: RoomShape,
-): Vector {
+): Readonly<Vector> {
   const gridWidth = getRoomShapeWidth(roomShape);
 
   const x = (gridIndex % gridWidth) - 1;
@@ -49,7 +52,9 @@ export function gridIndexToGridPosition(
  *
  * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
  */
-export function gridPositionToWorldPosition(gridPosition: Vector): Vector {
+export function gridPositionToWorldPosition(
+  gridPosition: Vector,
+): Readonly<Vector> {
   const x = (gridPosition.X + 2) * 40;
   const y = (gridPosition.Y + 4) * 40;
 
@@ -99,7 +104,9 @@ function isValidGridPositionLRoom(gridPosition: Vector, roomShape: RoomShape) {
  *
  * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
  */
-export function worldPositionToGridPosition(worldPos: Vector): Vector {
+export function worldPositionToGridPosition(
+  worldPos: Vector,
+): Readonly<Vector> {
   const x = Math.round(worldPos.X / 40 - 2);
   const y = Math.round(worldPos.Y / 40 - 4);
   return Vector(x, y);
@@ -112,7 +119,9 @@ export function worldPositionToGridPosition(worldPos: Vector): Vector {
  *
  * This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
  */
-export function worldPositionToGridPositionFast(worldPos: Vector): Vector {
+export function worldPositionToGridPositionFast(
+  worldPos: Vector,
+): Readonly<Vector> {
   const x = worldPos.X / 40 - 2;
   const y = worldPos.Y / 40 - 4;
   return Vector(x, y);

package/src/functions/ui.ts

@@ -13,7 +13,7 @@ import { copyVector } from "./vector";
  * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
  * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
  */
-export function getHUDOffsetVector(): Vector {
+export function getHUDOffsetVector(): Readonly<Vector> {
   // Convert e.g. 0.4 to 4.
   const hudOffset = math.floor(Options.HUDOffset * 10);
 
@@ -89,38 +89,38 @@ export function getHeartsUIWidth(): int {
   return width;
 }
 
-export function getScreenBottomCenterPos(): Vector {
+export function getScreenBottomCenterPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return Vector(bottomRight.X / 2, bottomRight.Y);
 }
 
-export function getScreenBottomLeftPos(): Vector {
+export function getScreenBottomLeftPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return Vector(0, bottomRight.Y);
 }
 
-export function getScreenBottomRightPos(): Vector {
+export function getScreenBottomRightPos(): Readonly<Vector> {
   const screenWidth = Isaac.GetScreenWidth();
   const screenHeight = Isaac.GetScreenHeight();
 
   return Vector(screenWidth, screenHeight);
 }
 
-export function getScreenCenterPos(): Vector {
+export function getScreenCenterPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return bottomRight.div(2);
 }
 
-export function getScreenTopCenterPos(): Vector {
+export function getScreenTopCenterPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return Vector(bottomRight.X / 2, 0);
 }
 
-export function getScreenTopLeftPos(): Vector {
+export function getScreenTopLeftPos(): Readonly<Vector> {
   return copyVector(VectorZero);
 }
 
-export function getScreenTopRightPos(): Vector {
+export function getScreenTopRightPos(): Readonly<Vector> {
   const bottomRight = getScreenBottomRightPos();
   return Vector(bottomRight.X, 0);
 }

package/src/functions/vector.ts

@@ -90,7 +90,7 @@ export function doesVectorHaveLength(
  */
 export function getRandomVector(
   seedOrRNG: Seed | RNG = getRandomSeed(),
-): Vector {
+): Readonly<Vector> {
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
   const x = getRandomFloat(-1, 1, rng);