isaacscript-common 26.2.0 → 26.3.0

package/src/functions/players.ts

@@ -13,6 +13,7 @@ import {
   TRINKET_SLOT_VALUES,
 } from "../arrays/cachedEnumValues";
 import { game, itemConfig } from "../core/cachedClasses";
+import { ReadonlySet } from "../types/ReadonlySet";
 import { getLastElement, sumArray } from "./array";
 import { getCharacterName, isVanillaCharacter } from "./characters";
 import { getCollectibleMaxCharges } from "./collectibles";
@@ -82,7 +83,7 @@ export function anyPlayerHasTrinket(trinketType: TrinketType): boolean {
  * for. Returns true if any of the characters supplied are present.
  */
 export function anyPlayerIs(...matchingCharacters: PlayerType[]): boolean {
-  const matchingCharacterSet = new Set(matchingCharacters);
+  const matchingCharacterSet = new ReadonlySet(matchingCharacters);
   const characters = getCharacters();
   return characters.some((character) => matchingCharacterSet.has(character));
 }
@@ -365,7 +366,7 @@ export function getPlayerNumHitsRemaining(player: EntityPlayer): int {
  * for. Returns true if any of the characters supplied are present.
  */
 export function getPlayersOfType(...characters: PlayerType[]): EntityPlayer[] {
-  const charactersSet = new Set(characters);
+  const charactersSet = new ReadonlySet(characters);
   const players = getPlayers();
   return players.filter((player) => {
     const character = player.GetPlayerType();
@@ -481,7 +482,7 @@ export function hasCollectibleInActiveSlot(
   collectibleType: CollectibleType,
   ...activeSlots: ActiveSlot[]
 ): boolean {
-  const matchingActiveSlotsSet = new Set(activeSlots);
+  const matchingActiveSlotsSet = new ReadonlySet(activeSlots);
   const activeItemSlots = getActiveItemSlots(player, collectibleType);
   return activeItemSlots.some((activeSlot) =>
     matchingActiveSlotsSet.has(activeSlot),
@@ -568,7 +569,7 @@ export function isCharacter(
   player: EntityPlayer,
   ...characters: PlayerType[]
 ): boolean {
-  const characterSet = new Set(characters);
+  const characterSet = new ReadonlySet(characters);
   const character = player.GetPlayerType();
   return characterSet.has(character);
 }

package/src/functions/random.ts

@@ -1,3 +1,4 @@
+import { ReadonlySet } from "../types/ReadonlySet";
 import { getRandomSeed, isRNG, newRNG } from "./rng";
 
 /**
@@ -81,7 +82,7 @@ export function getRandomInt(
     max = oldMin;
   }
 
-  const exceptionsSet = new Set(exceptions);
+  const exceptionsSet = new ReadonlySet(exceptions);
 
   let randomInt: int;
   do {

package/src/functions/roomShapeWalls.ts

@@ -3,6 +3,7 @@ import { ROOM_SHAPE_VALUES } from "../arrays/cachedEnumValues";
 import { game } from "../core/cachedClasses";
 import { CornerType } from "../enums/CornerType";
 import { Corner } from "../interfaces/Corner";
+import { ReadonlySet } from "../types/ReadonlySet";
 import { getGridIndexesBetween } from "./gridIndex";
 import { inBossRoomOf, inHomeCloset } from "./rooms";
 import { getRoomShapeCorners, isLRoom } from "./roomShape";
@@ -38,7 +39,7 @@ function getVanillaWallGridIndexSetForRoomShape(
     case RoomShape.LTL: {
       const [topMiddle, topRight, middleLeft, middle, bottomLeft, bottomRight] =
         corners as [Corner, Corner, Corner, Corner, Corner, Corner];
-      return new Set([
+      return new ReadonlySet([
         // Horizontal
         ...getGridIndexesBetween(
           topMiddle.gridIndex,
@@ -79,7 +80,7 @@ function getVanillaWallGridIndexSetForRoomShape(
     case RoomShape.LTR: {
       const [topLeft, topMiddle, middle, middleRight, bottomLeft, bottomRight] =
         corners as [Corner, Corner, Corner, Corner, Corner, Corner];
-      return new Set([
+      return new ReadonlySet([
         // Horizontal
         ...getGridIndexesBetween(
           topLeft.gridIndex,
@@ -120,7 +121,7 @@ function getVanillaWallGridIndexSetForRoomShape(
     case RoomShape.LBL: {
       const [topLeft, topRight, middleLeft, middle, bottomMiddle, bottomRight] =
         corners as [Corner, Corner, Corner, Corner, Corner, Corner];
-      return new Set([
+      return new ReadonlySet([
         // Horizontal
         ...getGridIndexesBetween(
           topLeft.gridIndex,
@@ -161,7 +162,7 @@ function getVanillaWallGridIndexSetForRoomShape(
     case RoomShape.LBR: {
       const [topLeft, topRight, middle, middleRight, bottomLeft, bottomMiddle] =
         corners as [Corner, Corner, Corner, Corner, Corner, Corner];
-      return new Set([
+      return new ReadonlySet([
         // Horizontal
         ...getGridIndexesBetween(
           topLeft.gridIndex,
@@ -225,7 +226,7 @@ function getWallGridIndexSetForRectangleRoomShape(
     Corner,
   ];
 
-  return new Set([
+  return new ReadonlySet([
     // Horizontal
     ...getGridIndexesBetween(topLeft.gridIndex, topRight.gridIndex, roomShape),
     ...getGridIndexesBetween(

package/src/functions/rooms.ts

@@ -21,6 +21,7 @@ import { game, sfxManager } from "../core/cachedClasses";
 import { MAX_LEVEL_GRID_INDEX } from "../core/constants";
 import { ROOM_TYPE_NAMES } from "../objects/roomTypeNames";
 import { MINE_SHAFT_ROOM_SUB_TYPE_SET } from "../sets/mineShaftRoomSubTypesSet";
+import { ReadonlySet } from "../types/ReadonlySet";
 import { getAllDimensions, inDimension } from "./dimensions";
 import {
   closeAllDoors,
@@ -535,7 +536,7 @@ export function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean {
   if (onlyCheckRoomTypes === undefined) {
     matchingRooms = rooms;
   } else {
-    const roomTypeWhitelist = new Set(onlyCheckRoomTypes);
+    const roomTypeWhitelist = new ReadonlySet(onlyCheckRoomTypes);
     matchingRooms = rooms.filter(
       (roomDescriptor) =>
         roomDescriptor.Data !== undefined &&

package/src/functions/set.ts

@@ -1,3 +1,4 @@
+import { ReadonlySet } from "../types/ReadonlySet";
 import { getArrayCombinations, getRandomArrayElement, sumArray } from "./array";
 import { getRandomSeed } from "./rng";
 import { isPrimitive } from "./types";
@@ -107,7 +108,7 @@ export function getSetCombinations<T>(
   const values = getSortedSetValues(set);
   const combinations = getArrayCombinations(values, includeEmptyArray);
 
-  return combinations.map((array) => new Set(array));
+  return combinations.map((array) => new ReadonlySet(array));
 }
 
 /**

package/src/functions/utils.ts

@@ -1,5 +1,6 @@
 import { RenderMode } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
+import { ReadonlySet } from "../types/ReadonlySet";
 import { getAllPlayers } from "./playerIndex";
 import { isFunction } from "./types";
 
@@ -88,7 +89,7 @@ export function inRange(num: int, start: int, end: int): boolean {
 export function isMultiplayer(): boolean {
   const players = getAllPlayers();
   const controllerIndexes = players.map((player) => player.ControllerIndex);
-  const controllerIndexesSet = new Set(controllerIndexes);
+  const controllerIndexesSet = new ReadonlySet(controllerIndexes);
 
   return controllerIndexesSet.size > 1;
 }

package/src/functions/vector.ts

@@ -151,6 +151,13 @@ export function vectorToDirection(vector: Vector): Direction {
   return angleToDirection(angleDegrees);
 }
 
+/**
+ * Helper function to convert a vector to a string.
+ *
+ * @param vector The vector to convert.
+ * @param round Optional. If true, will round the vector values to the nearest integer. Default is
+ *              false.
+ */
 export function vectorToString(vector: Vector, round = false): string {
   const x = round ? Math.round(vector.X) : vector.X;
   const y = round ? Math.round(vector.Y) : vector.Y;

package/src/index.ts

@@ -93,6 +93,7 @@ export * from "./functions/positionVelocity";
 export * from "./functions/pressurePlate";
 export * from "./functions/projectiles";
 export * from "./functions/random";
+export * from "./functions/readOnly";
 export * from "./functions/revive";
 export * from "./functions/rng";
 export * from "./functions/rockAlt";