isaacscript-common 80.2.4 → 81.0.0

package/src/functions/projectiles.ts

@@ -29,7 +29,7 @@ export function fireProjectiles(
   velocity: Vector,
   projectilesMode: ProjectilesMode = ProjectilesMode.ONE_PROJECTILE,
   projectileParams: ProjectileParams = ProjectileParams(),
-): EntityProjectile[] {
+): readonly EntityProjectile[] {
   const oldProjectiles = getProjectiles(projectileParams.Variant);
 
   let spawnedFly = false;
@@ -67,7 +67,7 @@ export function fireProjectilesInCircle(
   position: Vector,
   speed: float,
   numProjectiles: int,
-): EntityProjectile[] {
+): readonly EntityProjectile[] {
   const velocity = Vector(speed, numProjectiles);
   return fireProjectiles(
     npc,

package/src/functions/rooms.ts

@@ -97,7 +97,7 @@ export function getNumRooms(): int {
  * method. This is the best way to see if off-grid rooms have been initialized, since it is possible
  * for mods to insert room data at non-official negative room grid indexes.
  */
-export function getReadOnlyRooms(): Array<Readonly<RoomDescriptor>> {
+export function getReadOnlyRooms(): ReadonlyArray<Readonly<RoomDescriptor>> {
   const level = game.GetLevel();
   const roomList = level.GetRooms();
 
@@ -200,7 +200,7 @@ export function getRoomTypeName(roomType: RoomType): string {
  */
 export function getRooms(
   includeExtraDimensionalRooms = false,
-): RoomDescriptor[] {
+): readonly RoomDescriptor[] {
   // The naive way to get all of the rooms would be to iterate over the `RoomList` from the
   // `Level.GetRooms` method. However, this results in read-only data, and we want to return a
   // writable object. Instead, we let the heavy lifting be handled by other functions.
@@ -221,7 +221,7 @@ export function getRooms(
  */
 export function getRoomsInsideGrid(
   includeExtraDimensionalRooms = false,
-): RoomDescriptor[] {
+): readonly RoomDescriptor[] {
   const level = game.GetLevel();
 
   const dimensions = includeExtraDimensionalRooms
@@ -250,7 +250,9 @@ export function getRoomsInsideGrid(
  *
  * Room descriptors without any data are assumed to be non-existent and are not included.
  */
-export function getRoomsOfDimension(dimension: Dimension): RoomDescriptor[] {
+export function getRoomsOfDimension(
+  dimension: Dimension,
+): readonly RoomDescriptor[] {
   const level = game.GetLevel();
 
   /** We use a map instead of an array because room shapes occupy more than one room grid index. */
@@ -273,7 +275,7 @@ export function getRoomsOfDimension(dimension: Dimension): RoomDescriptor[] {
  *
  * Room descriptors without any data are assumed to be non-existent and are not included.
  */
-export function getRoomsOutsideGrid(): RoomDescriptor[] {
+export function getRoomsOutsideGrid(): readonly RoomDescriptor[] {
   // We filter an array of all rooms instead of iterating over the `GridRoom` enum because it is
   // possible for mods to insert data at arbitrary negative room grid indexes.
   const readOnlyRooms = getReadOnlyRooms();
@@ -550,7 +552,7 @@ export function isAllRoomsClear(
 ): boolean {
   const roomsInsideGrid = getRoomsInsideGrid();
 
-  let matchingRooms: RoomDescriptor[];
+  let matchingRooms: readonly RoomDescriptor[];
   if (onlyCheckRoomTypes === undefined) {
     matchingRooms = roomsInsideGrid;
   } else {

package/src/functions/run.ts

@@ -37,7 +37,7 @@ export function anySeedEffectEnabled(exceptions?: SeedEffect[]): boolean {
 /**
  * Helper function to get the seed effects (i.e. Easter Eggs) that are enabled for the current run.
  */
-export function getSeedEffects(): SeedEffect[] {
+export function getSeedEffects(): readonly SeedEffect[] {
   const seeds = game.GetSeeds();
 
   return SEED_EFFECTS.filter(

package/src/functions/set.ts

@@ -120,6 +120,7 @@ export function getSetCombinations<T>(
  * Normally, set values are returned in insertion order, so use this function when the ordering of
  * the contents is important.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function getSortedSetValues<T>(set: Set<T> | ReadonlySet<T>): T[] {
   const values = [...set];
 

package/src/functions/sort.ts

@@ -146,6 +146,7 @@ export function sortTwoDimensionalArray<T>(a: T[], b: T[]): -1 | 0 | 1 {
  *
  * Under the hood, this uses the merge sort algorithm.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function stableSort<T>(
   array: T[],
   sortFunc: (a: T, b: T) => -1 | 0 | 1 = sortNormal,

package/src/functions/sprites.ts

@@ -23,7 +23,7 @@ import { eRange } from "./utils";
  *
  * @allowEmptyVariadic
  */
-export function clearSprite(sprite: Sprite, ...layerIDs: int[]): void {
+export function clearSprite(sprite: Sprite, ...layerIDs: readonly int[]): void {
   if (layerIDs.length === 0) {
     const numLayers = sprite.GetLayerCount();
     layerIDs = eRange(numLayers);

package/src/functions/table.ts

@@ -44,7 +44,7 @@ export function getBooleansFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
   ...keys: string[]
-): boolean[] {
+): readonly boolean[] {
   const booleans: boolean[] = [];
   for (const key of keys) {
     const value = luaMap.get(key);
@@ -76,7 +76,7 @@ export function getNumbersFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
   ...keys: string[]
-): number[] {
+): readonly number[] {
   const numbers: number[] = [];
   for (const key of keys) {
     const value = luaMap.get(key);
@@ -115,7 +115,7 @@ export function getStringsFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
   ...keys: string[]
-): string[] {
+): readonly string[] {
   const strings: string[] = [];
   for (const key of keys) {
     const value = luaMap.get(key);

package/src/functions/utils.ts

@@ -61,7 +61,7 @@ export function assertNotNull<T>(
  *            first argument will be the end.
  * @param increment Optional. The increment to use. Default is 1.
  */
-export function eRange(start: int, end?: int, increment = 1): int[] {
+export function eRange(start: int, end?: int, increment = 1): readonly int[] {
   if (end === undefined) {
     return eRange(0, start, increment);
   }
@@ -118,7 +118,7 @@ export function getTraversalDescription(
  *            first argument will be the end.
  * @param increment Optional. The increment to use. Default is 1.
  */
-export function iRange(start: int, end?: int, increment = 1): int[] {
+export function iRange(start: int, end?: int, increment = 1): readonly int[] {
   if (end === undefined) {
     return iRange(0, start, increment);
   }