isaacscript-common 80.2.4 → 81.0.0

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 80.2.3
+isaacscript-common 80.2.5
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -27717,7 +27717,8 @@ end
 -- to an `InitCharge` value of -1. However, in some cases, this may be different. For example,
 -- Eden's Soul starts without any charges, so it has an `InitCharge` value of 0.
 -- 
--- This function returns 0 if the provided collectible type was not valid.
+-- This function returns 0 if the provided collectible type was not valid. This function returns -1
+-- if the provided collectible type was not an active collectible.
 function ____exports.getCollectibleInitCharge(self, collectibleOrCollectibleType)
     local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "getCollectibleInitCharge")
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "80.2.4",
+  "version": "81.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -37,6 +37,6 @@
     "lint": "tsx --tsconfig ./scripts/tsconfig.json ./scripts/lint.mts"
   },
   "dependencies": {
-    "isaac-typescript-definitions": "^39.0.4"
+    "isaac-typescript-definitions": "^39.0.5"
   }
 }

package/src/classes/ModUpgraded.ts

@@ -412,7 +412,7 @@ export class ModUpgraded implements Mod {
    * called from the "upgradeMod" function, but we want to mark it as private so that end-users
    * don't have access to it.
    */
-  private initOptionalFeature(feature: ISCFeature): FunctionTuple[] {
+  private initOptionalFeature(feature: ISCFeature): readonly FunctionTuple[] {
     const featureClass = this.features[feature];
     this.initFeature(featureClass);
 
@@ -427,7 +427,9 @@ export class ModUpgraded implements Mod {
  * Exported methods are stored in an internal static array on the class that is created by the
  * decorator.
  */
-function getExportedMethodsFromFeature(featureClass: unknown): FunctionTuple[] {
+function getExportedMethodsFromFeature(
+  featureClass: unknown,
+): readonly FunctionTuple[] {
   const constructor = getTSTLClassConstructor(featureClass) as Record<
     string,
     unknown

package/src/functions/array.ts

@@ -34,6 +34,7 @@ export function arrayEquals<T>(
  * matching element. If you want to remove all of the elements, use the `arrayRemoveAll` function
  * instead.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function arrayRemove<T>(
   originalArray: T[] | readonly T[],
   ...elementsToRemove: T[]
@@ -61,6 +62,7 @@ export function arrayRemove<T>(
  * element. If you want to only remove the first matching element, use the `arrayRemove` function
  * instead.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function arrayRemoveAll<T>(
   originalArray: T[] | readonly T[],
   ...elementsToRemove: T[]
@@ -113,6 +115,7 @@ export function arrayRemoveAllInPlace<T>(
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function arrayRemoveInPlace<T>(
   array: T[],
   ...elementsToRemove: T[]
@@ -137,6 +140,7 @@ export function arrayRemoveInPlace<T>(
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function arrayRemoveIndex<T>(
   originalArray: T[] | readonly T[],
   ...indexesToRemove: int[]
@@ -161,6 +165,7 @@ export function arrayRemoveIndex<T>(
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function arrayRemoveIndexInPlace<T>(
   array: T[],
   ...indexesToRemove: int[]
@@ -203,6 +208,7 @@ export function arrayToString(array: unknown[]): string {
  * This function is variadic, meaning that you can specify N arguments to combine N arrays. Note
  * that this will only perform a shallow copy of the array elements.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function combineArrays<T>(...arrays: Array<T[] | readonly T[]>): T[] {
   const elements: T[] = [];
   for (const array of arrays) {
@@ -221,6 +227,7 @@ export function combineArrays<T>(...arrays: Array<T[] | readonly T[]>): T[] {
  * @param numElements Optional. If specified, will only copy the first N elements. By default, the
  *                    entire array will be copied.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function copyArray<T>(
   oldArray: T[] | readonly T[],
   numElements?: int,
@@ -256,6 +263,7 @@ export function emptyArray<T>(array: T[]): void {
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function filterMap<OldT, NewT>(
   array: OldT[] | readonly OldT[],
   func: (element: OldT) => NewT | undefined,
@@ -353,7 +361,7 @@ function addCombinations<T>(
  * due to implementation details of TypeScriptToLua, this results in an array of 1 through N
  * (instead of an array of 0 through N -1).
  */
-export function getArrayIndexes<T>(array: T[] | readonly T[]): int[] {
+export function getArrayIndexes<T>(array: T[] | readonly T[]): readonly int[] {
   return eRange(array.length);
 }
 
@@ -599,6 +607,7 @@ export function setAllArrayElements<T>(array: T[], value: T): void {
  *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
  *                  a random seed.
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function shuffleArray<T>(
   originalArray: T[] | readonly T[],
   seedOrRNG: Seed | RNG | undefined,

package/src/functions/arrayLua.ts

@@ -30,7 +30,7 @@ export function every<T>(
 export function filter<T>(
   array: T[],
   func: (value: T, index: number, array: T[]) => boolean,
-): T[] {
+): readonly T[] {
   return array.filter(func);
 }
 
@@ -79,7 +79,7 @@ export function join<T>(array: T[], separator: string): string {
 export function map<T, U>(
   array: T[],
   func: (value: T, index: number, array: T[]) => U,
-): U[] {
+): readonly U[] {
   return array.map(func);
 }
 

package/src/functions/benchmark.ts

@@ -16,7 +16,7 @@ import { log } from "./log";
 export function benchmark(
   numTrials: int,
   ...functions: Array<() => void>
-): int[] {
+): readonly int[] {
   log(`Benchmarking ${functions.length} function(s) with ${numTrials} trials.`);
 
   const averages: int[] = [];

package/src/functions/bitwise.ts

@@ -28,7 +28,10 @@ export function convertBinaryToDecimal(bits: int[]): number {
  *                  side until the minimum length is met. Default is undefined (which will not cause
  *                  any padding).
  */
-export function convertDecimalToBinary(num: number, minLength?: int): int[] {
+export function convertDecimalToBinary(
+  num: number,
+  minLength?: int,
+): readonly int[] {
   const bits: int[] = [];
 
   const bitsString = num.toString(2);

package/src/functions/bosses.ts

@@ -55,7 +55,7 @@ export function getAliveBosses(
   variant = -1,
   subType = -1,
   ignoreFriendly = false,
-): EntityNPC[] {
+): readonly EntityNPC[] {
   const aliveNPCs = getAliveNPCs(entityType, variant, subType, ignoreFriendly);
   return aliveNPCs.filter((aliveNPC) => aliveNPC.IsBoss());
 }
@@ -175,7 +175,7 @@ export function getBosses(
   variant?: int,
   subType?: int,
   ignoreFriendly = false,
-): EntityNPC[] {
+): readonly EntityNPC[] {
   const npcs = getNPCs(entityType, variant, subType, ignoreFriendly);
   return npcs.filter((npc) => npc.IsBoss());
 }

package/src/functions/charge.ts

@@ -247,7 +247,7 @@ export function getTotalCharge(
 export function getUsableActiveItemSlots(
   player: EntityPlayer,
   collectibleType: CollectibleType,
-): ActiveSlot[] {
+): readonly ActiveSlot[] {
   const maxCharges = getCollectibleMaxCharges(collectibleType);
   const activeSlots = getActiveItemSlots(player, collectibleType);
   return activeSlots.filter((activeSlot) => {

package/src/functions/collectibles.ts

@@ -283,7 +283,8 @@ export function getCollectibleGfxFilename(
  * to an `InitCharge` value of -1. However, in some cases, this may be different. For example,
  * Eden's Soul starts without any charges, so it has an `InitCharge` value of 0.
  *
- * This function returns 0 if the provided collectible type was not valid.
+ * This function returns 0 if the provided collectible type was not valid. This function returns -1
+ * if the provided collectible type was not an active collectible.
  */
 export function getCollectibleInitCharge(
   collectibleOrCollectibleType: EntityPickup | CollectibleType,

package/src/functions/deepCopy.ts

@@ -560,7 +560,7 @@ function deepCopyArray(
   traversalDescription: string,
   classConstructors: LuaMap<string, AnyClass>,
   insideMap: boolean,
-) {
+): readonly unknown[] {
   if (SAVE_DATA_MANAGER_DEBUG) {
     log("deepCopy is copying an array.");
   }

package/src/functions/doors.ts

@@ -58,7 +58,7 @@ export function doorSlotFlagToDoorSlot(doorSlotFlag: DoorSlotFlag): DoorSlot {
 
 export function doorSlotFlagsToDoorSlots(
   doorSlotFlags: BitFlags<DoorSlotFlag>,
-): DoorSlot[] {
+): readonly DoorSlot[] {
   const doorSlots: DoorSlot[] = [];
 
   for (const doorSlotFlag of DOOR_SLOT_FLAG_VALUES) {
@@ -204,7 +204,7 @@ export function getDoorSlotsForRoomShape(
  *
  * @allowEmptyVariadic
  */
-export function getDoors(...roomTypes: RoomType[]): GridEntityDoor[] {
+export function getDoors(...roomTypes: RoomType[]): readonly GridEntityDoor[] {
   const room = game.GetRoom();
   const roomShape = room.GetRoomShape();
   const roomTypesSet = new ReadonlySet(roomTypes);
@@ -240,7 +240,9 @@ export function getDoors(...roomTypes: RoomType[]): GridEntityDoor[] {
  * This function is variadic, meaning that you can specify N arguments to return all of the doors
  * that match any of the N room grid indexes.
  */
-export function getDoorsToRoomIndex(...roomGridIndex: int[]): GridEntityDoor[] {
+export function getDoorsToRoomIndex(
+  ...roomGridIndex: int[]
+): readonly GridEntityDoor[] {
   const roomGridIndexesSet = new ReadonlySet(roomGridIndex);
   const doors = getDoors();
   return doors.filter((door) => roomGridIndexesSet.has(door.TargetRoomIndex));
@@ -320,7 +322,7 @@ export function getRoomShapeDoorSlotCoordinates(
  * Helper function to find unused door slots in the current room that can be used to make custom
  * doors.
  */
-export function getUnusedDoorSlots(): DoorSlot[] {
+export function getUnusedDoorSlots(): readonly DoorSlot[] {
   const room = game.GetRoom();
 
   return DOOR_SLOT_VALUES.filter(

package/src/functions/entities.ts

@@ -241,7 +241,7 @@ export function getEntities(
   variant = -1,
   subType = -1,
   ignoreFriendly = false,
-): Entity[] {
+): readonly Entity[] {
   if (entityType === -1) {
     return Isaac.GetRoomEntities();
   }
@@ -345,9 +345,9 @@ export function getEntityIDFromConstituents(
  * second array but not in the first array.
  */
 export function getFilteredNewEntities<T extends AnyEntity>(
-  oldEntities: T[],
-  newEntities: T[],
-): T[] {
+  oldEntities: T[] | readonly T[],
+  newEntities: T[] | readonly T[],
+): readonly T[] {
   const oldEntitiesSet = new Set<PtrHash>();
   for (const entity of oldEntities) {
     const ptrHash = GetPtrHash(entity);
@@ -549,7 +549,7 @@ export function removeAllMatchingEntities(
   entityVariant = -1,
   entitySubType = -1,
   cap: int | undefined = undefined,
-): Entity[] {
+): readonly Entity[] {
   const entities = getEntities(entityType, entityVariant, entitySubType);
   return removeEntities(entities, cap);
 }
@@ -562,9 +562,9 @@ export function removeAllMatchingEntities(
  * @returns An array of the entities that were removed.
  */
 export function removeEntities<T extends AnyEntity>(
-  entities: T[],
+  entities: T[] | readonly T[],
   cap?: int,
-): T[] {
+): readonly T[] {
   if (entities.length === 0) {
     return [];
   }

package/src/functions/entitiesSpecific.ts

@@ -35,7 +35,7 @@ import { assertDefined } from "./utils";
 export function getBombs(
   bombVariant: BombVariant | -1 = -1,
   subType = -1,
-): EntityBomb[] {
+): readonly EntityBomb[] {
   const entities = getEntities(EntityType.BOMB, bombVariant, subType);
 
   const bombs: EntityBomb[] = [];
@@ -69,7 +69,7 @@ export function getBombs(
 export function getEffects(
   effectVariant: EffectVariant | -1 = -1,
   subType = -1,
-): EntityEffect[] {
+): readonly EntityEffect[] {
   const entities = getEntities(EntityType.EFFECT, effectVariant, subType);
 
   const effects: EntityEffect[] = [];
@@ -103,7 +103,7 @@ export function getEffects(
 export function getFamiliars(
   familiarVariant: FamiliarVariant | -1 = -1,
   subType = -1,
-): EntityFamiliar[] {
+): readonly EntityFamiliar[] {
   const entities = getEntities(EntityType.FAMILIAR, familiarVariant, subType);
 
   const familiars: EntityFamiliar[] = [];
@@ -137,7 +137,7 @@ export function getFamiliars(
 export function getKnives(
   knifeVariant: KnifeVariant | -1 = -1,
   subType = -1,
-): EntityKnife[] {
+): readonly EntityKnife[] {
   const entities = getEntities(EntityType.KNIFE, knifeVariant, subType);
 
   const knives: EntityKnife[] = [];
@@ -171,7 +171,7 @@ export function getKnives(
 export function getLasers(
   laserVariant: LaserVariant | -1 = -1,
   subType = -1,
-): EntityLaser[] {
+): readonly EntityLaser[] {
   const entities = getEntities(EntityType.LASER, laserVariant, subType);
 
   const lasers: EntityLaser[] = [];
@@ -203,7 +203,7 @@ export function getNPCs(
   variant = -1,
   subType = -1,
   ignoreFriendly = false,
-): EntityNPC[] {
+): readonly EntityNPC[] {
   const entities = getEntities(entityType, variant, subType, ignoreFriendly);
 
   const npcs: EntityNPC[] = [];
@@ -237,7 +237,7 @@ export function getNPCs(
 export function getPickups(
   pickupVariant: PickupVariant | -1 = -1,
   subType = -1,
-): EntityPickup[] {
+): readonly EntityPickup[] {
   const entities = getEntities(EntityType.PICKUP, pickupVariant, subType);
 
   const pickups: EntityPickup[] = [];
@@ -271,7 +271,7 @@ export function getPickups(
 export function getProjectiles(
   projectileVariant: ProjectileVariant | -1 = -1,
   subType = -1,
-): EntityProjectile[] {
+): readonly EntityProjectile[] {
   const entities = getEntities(
     EntityType.PROJECTILE,
     projectileVariant,
@@ -309,7 +309,7 @@ export function getProjectiles(
 export function getSlots(
   slotVariant: SlotVariant | -1 = -1,
   subType = -1,
-): EntitySlot[] {
+): readonly EntitySlot[] {
   const slots = getEntities(EntityType.SLOT, slotVariant, subType);
 
   return slots as EntitySlot[];
@@ -335,7 +335,7 @@ export function getSlots(
 export function getTears(
   tearVariant: TearVariant | -1 = -1,
   subType = -1,
-): EntityTear[] {
+): readonly EntityTear[] {
   const entities = getEntities(EntityType.TEAR, tearVariant, subType);
 
   const tears: EntityTear[] = [];
@@ -364,7 +364,7 @@ export function removeAllBombs(
   bombVariant: BombVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): EntityBomb[] {
+): readonly EntityBomb[] {
   const bombs = getBombs(bombVariant, subType);
   return removeEntities(bombs, cap);
 }
@@ -383,7 +383,7 @@ export function removeAllEffects(
   effectVariant: EffectVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): EntityEffect[] {
+): readonly EntityEffect[] {
   const effects = getEffects(effectVariant, subType);
   return removeEntities(effects, cap);
 }
@@ -402,7 +402,7 @@ export function removeAllFamiliars(
   familiarVariant: FamiliarVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): EntityFamiliar[] {
+): readonly EntityFamiliar[] {
   const familiars = getFamiliars(familiarVariant, subType);
   return removeEntities(familiars, cap);
 }
@@ -421,7 +421,7 @@ export function removeAllKnives(
   knifeVariant: KnifeVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): EntityKnife[] {
+): readonly EntityKnife[] {
   const knives = getKnives(knifeVariant, subType);
   return removeEntities(knives, cap);
 }
@@ -440,7 +440,7 @@ export function removeAllLasers(
   laserVariant: LaserVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): EntityLaser[] {
+): readonly EntityLaser[] {
   const lasers = getLasers(laserVariant, subType);
   return removeEntities(lasers, cap);
 }
@@ -462,7 +462,7 @@ export function removeAllNPCs(
   variant = -1,
   subType = -1,
   cap?: int,
-): EntityNPC[] {
+): readonly EntityNPC[] {
   const npcs = getNPCs(entityType, variant, subType);
   return removeEntities(npcs, cap);
 }
@@ -481,7 +481,7 @@ export function removeAllPickups(
   pickupVariant: PickupVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): EntityPickup[] {
+): readonly EntityPickup[] {
   const pickups = getPickups(pickupVariant, subType);
   return removeEntities(pickups, cap);
 }
@@ -500,7 +500,7 @@ export function removeAllProjectiles(
   projectileVariant: ProjectileVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): EntityProjectile[] {
+): readonly EntityProjectile[] {
   const projectiles = getProjectiles(projectileVariant, subType);
   return removeEntities(projectiles, cap);
 }
@@ -519,7 +519,7 @@ export function removeAllSlots(
   slotVariant: SlotVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): Entity[] {
+): readonly Entity[] {
   const slots = getSlots(slotVariant, subType);
   return removeEntities(slots, cap);
 }
@@ -538,7 +538,7 @@ export function removeAllTears(
   tearVariant: TearVariant | -1 = -1,
   subType = -1,
   cap?: int,
-): EntityTear[] {
+): readonly EntityTear[] {
   const tears = getTears(tearVariant, subType);
   return removeEntities(tears, cap);
 }

package/src/functions/enums.ts

@@ -32,7 +32,7 @@ export type TranspiledEnum = Record<
  */
 export function getEnumEntries<T extends TranspiledEnum>(
   transpiledEnum: T,
-): Array<[key: string, value: T[keyof T]]> {
+): ReadonlyArray<[key: string, value: T[keyof T]]> {
   // The values cannot simply be type `T` due to the special construction of bit flag enums.
   const enumEntries: Array<[key: string, value: T[keyof T]]> = [];
   for (const [key, value] of pairs(transpiledEnum)) {
@@ -70,7 +70,7 @@ export function getEnumEntries<T extends TranspiledEnum>(
  * For a more in depth explanation, see:
  * https://isaacscript.github.io/main/gotchas#iterating-over-enums
  */
-export function getEnumKeys(transpiledEnum: TranspiledEnum): string[] {
+export function getEnumKeys(transpiledEnum: TranspiledEnum): readonly string[] {
   const enumEntries = getEnumEntries(transpiledEnum);
   return enumEntries.map(([key, _value]) => key);
 }
@@ -98,7 +98,9 @@ export function getEnumLength(transpiledEnum: TranspiledEnum): int {
  * For a more in depth explanation, see:
  * https://isaacscript.github.io/main/gotchas#iterating-over-enums
  */
-export function getEnumNames(transpiledEnum: TranspiledEnum): string[] {
+export function getEnumNames(
+  transpiledEnum: TranspiledEnum,
+): readonly string[] {
   const enumNames: string[] = [];
 
   for (const [key, _value] of pairs(transpiledEnum)) {
@@ -132,7 +134,7 @@ export function getEnumNames(transpiledEnum: TranspiledEnum): string[] {
  */
 export function getEnumValues<T extends TranspiledEnum>(
   transpiledEnum: T,
-): Array<T[keyof T]> {
+): ReadonlyArray<T[keyof T]> {
   const enumEntries = getEnumEntries(transpiledEnum);
   return enumEntries.map(([_key, value]) => value);
 }

package/src/functions/familiars.ts

@@ -118,7 +118,9 @@ export function checkFamiliarFromCollectibles(
 }
 
 /** Helper function to get only the familiars that belong to a specific player. */
-export function getPlayerFamiliars(player: EntityPlayer): EntityFamiliar[] {
+export function getPlayerFamiliars(
+  player: EntityPlayer,
+): readonly EntityFamiliar[] {
   const playerPtrHash = GetPtrHash(player);
   const familiars = getFamiliars();
   return familiars.filter((familiar) => {

package/src/functions/gridEntities.ts

@@ -121,7 +121,7 @@ export function doesGridEntityExist(
  *
  * Under the hood, this uses the `Room.GetGridSize` method.
  */
-export function getAllGridIndexes(): int[] {
+export function getAllGridIndexes(): readonly int[] {
   const room = game.GetRoom();
   const gridSize = room.GetGridSize();
 
@@ -140,7 +140,7 @@ export function getAllGridIndexes(): int[] {
  */
 export function getCollidingEntitiesWithGridEntity(
   gridEntity: GridEntity,
-): Entity[] {
+): readonly Entity[] {
   const { topLeft, bottomRight } = getGridEntityCollisionPoints(gridEntity);
 
   const closeEntities = Isaac.FindInRadius(
@@ -228,7 +228,7 @@ export function getConstituentsFromGridEntityID(
  */
 export function getGridEntities(
   ...gridEntityTypes: GridEntityType[]
-): GridEntity[] {
+): readonly GridEntity[] {
   const gridEntities = getAllGridEntities();
 
   if (gridEntityTypes.length === 0) {
@@ -250,7 +250,7 @@ export function getGridEntities(
  */
 export function getGridEntitiesExcept(
   ...gridEntityTypes: GridEntityType[]
-): GridEntity[] {
+): readonly GridEntity[] {
   const gridEntities = getAllGridEntities();
 
   if (gridEntityTypes.length === 0) {
@@ -264,7 +264,7 @@ export function getGridEntitiesExcept(
   });
 }
 
-function getAllGridEntities(): GridEntity[] {
+function getAllGridEntities(): readonly GridEntity[] {
   const room = game.GetRoom();
 
   const gridEntities: GridEntity[] = [];
@@ -282,7 +282,7 @@ function getAllGridEntities(): GridEntity[] {
 export function getGridEntitiesInRadius(
   targetPosition: Vector,
   radius: number,
-): GridEntity[] {
+): readonly GridEntity[] {
   radius = Math.abs(radius);
   const topLeftOffset = VectorOne.mul(-radius);
   const mostTopLeftPosition = targetPosition.add(topLeftOffset);
@@ -528,7 +528,7 @@ export function getGridEntityIDFromConstituents(
 export function getMatchingGridEntities(
   gridEntityType: GridEntityType,
   variant: int,
-): GridEntity[] {
+): readonly GridEntity[] {
   const gridEntities = getGridEntities(gridEntityType);
   return gridEntities.filter(
     (gridEntity) => gridEntity.GetVariant() === variant,
@@ -698,7 +698,7 @@ function getRockPNGName(): string {
  */
 export function getSurroundingGridEntities(
   gridEntity: GridEntity,
-): GridEntity[] {
+): readonly GridEntity[] {
   const room = game.GetRoom();
   const gridIndex = gridEntity.GetGridIndex();
 
@@ -886,7 +886,7 @@ export function isPostBossVoidPortal(gridEntity: GridEntity): boolean {
  */
 export function removeAllGridEntitiesExcept(
   ...gridEntityTypes: GridEntityType[]
-): GridEntity[] {
+): readonly GridEntity[] {
   const gridEntityTypeExceptions = new ReadonlySet(gridEntityTypes);
   const gridEntities = getGridEntities();
   const removedGridEntities: GridEntity[] = [];
@@ -926,7 +926,7 @@ export function removeAllGridEntitiesExcept(
  */
 export function removeAllMatchingGridEntities(
   ...gridEntityType: GridEntityType[]
-): GridEntity[] {
+): readonly GridEntity[] {
   const gridEntities = getGridEntities(...gridEntityType);
   if (gridEntities.length === 0) {
     return [];
@@ -948,7 +948,7 @@ export function removeAllMatchingGridEntities(
  * You must specify an array of entities to look through.
  */
 export function removeEntitiesSpawnedFromGridEntity(
-  entities: Entity[],
+  entities: Entity[] | readonly Entity[],
   gridEntity: GridEntity,
 ): void {
   const entitiesFromGridEntity = entities.filter(
@@ -972,10 +972,10 @@ export function removeEntitiesSpawnedFromGridEntity(
  * @returns An array of the entities that were removed.
  */
 export function removeGridEntities<T extends AnyGridEntity>(
-  gridEntities: T[],
+  gridEntities: T[] | readonly T[],
   updateRoom: boolean,
   cap?: int,
-): T[] {
+): readonly T[] {
   if (gridEntities.length === 0) {
     return [];
   }