isaacscript-common 21.9.0 → 22.0.0

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);