isaacscript-common 80.2.4 → 81.0.0

package/src/functions/gridEntitiesSpecific.ts

@@ -25,7 +25,7 @@ import { assertDefined } from "./utils";
  */
 export function getCrawlSpaces(
   crawlSpaceVariant: CrawlSpaceVariant | -1 = -1,
-): GridEntity[] {
+): readonly GridEntity[] {
   if (crawlSpaceVariant === -1) {
     return getGridEntities(GridEntityType.CRAWL_SPACE);
   }
@@ -42,7 +42,9 @@ export function getCrawlSpaces(
  * @param pitVariant Optional. If specified, will only get the pits that match the variant. Default
  *                   is -1, which matches every variant.
  */
-export function getPits(pitVariant: PitVariant | -1 = -1): GridEntityPit[] {
+export function getPits(
+  pitVariant: PitVariant | -1 = -1,
+): readonly GridEntityPit[] {
   const pits: GridEntityPit[] = [];
   for (const gridEntity of getGridEntities()) {
     const pit = gridEntity.ToPit();
@@ -65,7 +67,7 @@ export function getPits(pitVariant: PitVariant | -1 = -1): GridEntityPit[] {
  */
 export function getPoops(
   poopVariant: PoopGridEntityVariant | -1 = -1,
-): GridEntityPoop[] {
+): readonly GridEntityPoop[] {
   const poops: GridEntityPoop[] = [];
   for (const gridEntity of getGridEntities()) {
     const poop = gridEntity.ToPoop();
@@ -88,7 +90,7 @@ export function getPoops(
  */
 export function getPressurePlates(
   pressurePlateVariant: PressurePlateVariant | -1 = -1,
-): GridEntityPressurePlate[] {
+): readonly GridEntityPressurePlate[] {
   const pressurePlates: GridEntityPressurePlate[] = [];
   for (const gridEntity of getGridEntities()) {
     const pressurePlate = gridEntity.ToPressurePlate();
@@ -114,7 +116,7 @@ export function getPressurePlates(
  *                `RockVariant` enum, since that only applies to `GridEntityType.ROCK`, and other
  *                types of grid entities can be the `GridEntityRock` class.
  */
-export function getRocks(variant = -1): GridEntityRock[] {
+export function getRocks(variant = -1): readonly GridEntityRock[] {
   const rocks: GridEntityRock[] = [];
   for (const gridEntity of getGridEntities()) {
     const rock = gridEntity.ToRock();
@@ -130,7 +132,7 @@ export function getRocks(variant = -1): GridEntityRock[] {
 }
 
 /** Helper function to get all of the `GridEntitySpikes` in the room. */
-export function getSpikes(variant = -1): GridEntitySpikes[] {
+export function getSpikes(variant = -1): readonly GridEntitySpikes[] {
   const spikes: GridEntitySpikes[] = [];
   for (const gridEntity of getGridEntities()) {
     const spike = gridEntity.ToSpikes();
@@ -146,7 +148,7 @@ export function getSpikes(variant = -1): GridEntitySpikes[] {
 }
 
 /** Helper function to get all of the `GridEntityTNT` in the room. */
-export function getTNT(variant = -1): GridEntityTNT[] {
+export function getTNT(variant = -1): readonly GridEntityTNT[] {
   const tntArray: GridEntityTNT[] = [];
   for (const gridEntity of getGridEntities()) {
     const tnt = gridEntity.ToTNT();
@@ -168,7 +170,7 @@ export function getTNT(variant = -1): GridEntityTNT[] {
  * @param variant Optional. If specified, will only get the teleporters that match the variant.
  *                Default is -1, which matches every variant.
  */
-export function getTeleporters(variant = -1): GridEntity[] {
+export function getTeleporters(variant = -1): readonly GridEntity[] {
   if (variant === -1) {
     return getGridEntities(GridEntityType.TELEPORTER);
   }
@@ -185,7 +187,7 @@ export function getTeleporters(variant = -1): GridEntity[] {
  */
 export function getTrapdoors(
   trapdoorVariant: TrapdoorVariant | -1 = -1,
-): GridEntity[] {
+): readonly GridEntity[] {
   if (trapdoorVariant === -1) {
     return getGridEntities(GridEntityType.TRAPDOOR);
   }
@@ -208,7 +210,7 @@ export function removeAllCrawlSpaces(
   crawlSpaceVariant: CrawlSpaceVariant | -1 = -1,
   updateRoom = false,
   cap?: int,
-): GridEntity[] {
+): readonly GridEntity[] {
   const crawlSpaces = getCrawlSpaces(crawlSpaceVariant);
   return removeGridEntities(crawlSpaces, updateRoom, cap);
 }
@@ -231,7 +233,7 @@ export function removeAllPits(
   pitVariant: PitVariant | -1 = -1,
   updateRoom = false,
   cap?: int,
-): GridEntityPit[] {
+): readonly GridEntityPit[] {
   const pits = getPits(pitVariant);
   return removeGridEntities(pits, updateRoom, cap);
 }
@@ -254,7 +256,7 @@ export function removeAllPoops(
   poopVariant: PoopGridEntityVariant | -1 = -1,
   updateRoom = false,
   cap?: int,
-): GridEntityPoop[] {
+): readonly GridEntityPoop[] {
   const poops = getPoops(poopVariant);
   return removeGridEntities(poops, updateRoom, cap);
 }
@@ -274,7 +276,7 @@ export function removeAllPressurePlates(
   pressurePlateVariant: PressurePlateVariant | -1 = -1,
   updateRoom = false,
   cap?: int,
-): GridEntityPressurePlate[] {
+): readonly GridEntityPressurePlate[] {
   const pressurePlates = getPressurePlates(pressurePlateVariant);
   return removeGridEntities(pressurePlates, updateRoom, cap);
 }
@@ -296,7 +298,7 @@ export function removeAllRocks(
   variant = -1,
   updateRoom = false,
   cap?: int,
-): GridEntityRock[] {
+): readonly GridEntityRock[] {
   const rocks = getRocks(variant);
   return removeGridEntities(rocks, updateRoom, cap);
 }
@@ -316,7 +318,7 @@ export function removeAllSpikes(
   variant = -1,
   updateRoom = false,
   cap?: int,
-): GridEntitySpikes[] {
+): readonly GridEntitySpikes[] {
   const spikes = getSpikes(variant);
   return removeGridEntities(spikes, updateRoom, cap);
 }
@@ -336,7 +338,7 @@ export function removeAllTNT(
   variant = -1,
   updateRoom = false,
   cap?: int,
-): GridEntityTNT[] {
+): readonly GridEntityTNT[] {
   const tnt = getTNT(variant);
   return removeGridEntities(tnt, updateRoom, cap);
 }
@@ -356,7 +358,7 @@ export function removeAllTeleporters(
   variant = -1,
   updateRoom = false,
   cap?: int,
-): GridEntity[] {
+): readonly GridEntity[] {
   const teleporters = getTeleporters(variant);
   return removeGridEntities(teleporters, updateRoom, cap);
 }
@@ -376,7 +378,7 @@ export function removeAllTrapdoors(
   trapdoorVariant: TrapdoorVariant | -1 = -1,
   updateRoom = false,
   cap?: int,
-): GridEntity[] {
+): readonly GridEntity[] {
   const trapdoors = getTrapdoors(trapdoorVariant);
   return removeGridEntities(trapdoors, updateRoom, cap);
 }

package/src/functions/gridIndex.ts

@@ -13,7 +13,7 @@ export function getGridIndexesBetween(
   gridIndex1: int,
   gridIndex2: int,
   roomShape: RoomShape,
-): int[] {
+): readonly int[] {
   if (gridIndex1 > gridIndex2) {
     const oldGridIndex1 = gridIndex1;
     const oldGridIndex2 = gridIndex2;

package/src/functions/input.ts

@@ -65,7 +65,7 @@ export function controllerToString(controller: Controller): string | undefined {
  */
 export function getMoveButtonActions(
   controllerIndex: ControllerIndex,
-): ButtonAction[] {
+): readonly ButtonAction[] {
   return MOVEMENT_BUTTON_ACTIONS.filter((buttonAction) =>
     Input.IsActionPressed(buttonAction, controllerIndex),
   );
@@ -78,7 +78,7 @@ export function getMoveButtonActions(
  */
 export function getShootButtonActions(
   controllerIndex: ControllerIndex,
-): ButtonAction[] {
+): readonly ButtonAction[] {
   return SHOOTING_BUTTON_ACTIONS.filter((buttonAction) =>
     Input.IsActionPressed(buttonAction, controllerIndex),
   );

package/src/functions/itemPool.ts

@@ -62,7 +62,7 @@ export function getDefaultCollectibleTypesInItemPool(
  */
 export function getDefaultItemPoolsForCollectibleType(
   collectibleType: CollectibleType,
-): ItemPoolType[] {
+): readonly ItemPoolType[] {
   const collectibleItemPoolTypes: ItemPoolType[] = [];
 
   const itemPoolTypes = game.IsGreedMode()

package/src/functions/jsonRoom.ts

@@ -129,7 +129,7 @@ export function getJSONRoomOfVariant(
 export function getJSONRoomsOfSubType(
   jsonRooms: JSONRoom[] | readonly JSONRoom[],
   subType: int,
-): JSONRoom[] {
+): readonly JSONRoom[] {
   return jsonRooms.filter((jsonRoom) => {
     const roomSubTypeString = jsonRoom.$.subtype;
     const roomSubType = parseIntSafe(roomSubTypeString);

package/src/functions/level.ts

@@ -40,7 +40,7 @@ export function fillLevelWithRedRooms(): void {
  * Note that this will only look at Boss Rooms inside of the grid, so e.g. Reverse Emperor card
  * rooms will not count.
  */
-export function getLevelBossIDs(): BossID[] {
+export function getLevelBossIDs(): readonly BossID[] {
   const roomsInsideGrid = getRoomsInsideGrid();
 
   return filterMap(roomsInsideGrid, (roomDescriptor) =>

package/src/functions/levelGrid.ts

@@ -319,7 +319,7 @@ export function getRoomAdjacentGridIndexes(
  */
 export function getRoomDescriptorsForType(
   ...roomTypes: RoomType[]
-): RoomDescriptor[] {
+): readonly RoomDescriptor[] {
   const roomTypesSet = new Set<RoomType>(roomTypes);
 
   const roomsInsideGrid = getRoomsInsideGrid();

package/src/functions/math.ts

@@ -35,7 +35,7 @@ export function getCircleDiscretizedPoints(
   xMultiplier = 1,
   yMultiplier = 1,
   initialDirection = Direction.UP,
-): Vector[] {
+): ReadonlyArray<Readonly<Vector>> {
   const vector = directionToVector(initialDirection);
   const initialPosition = vector.mul(radius);
   const positions: Vector[] = [];
@@ -163,7 +163,7 @@ export function splitNumber(
   num: int,
   size: int,
   startAtZero = false,
-): Array<[min: int, max: int]> {
+): ReadonlyArray<readonly [min: int, max: int]> {
   if (num <= 0) {
     error(
       `The number to split needs to be a positive number and is instead: ${num}`,

package/src/functions/newArray.ts

@@ -16,6 +16,7 @@ import { repeat } from "./utils";
  * const arrayWithArrays = newArray([0], 20); // Has 20 elements of an array with a 0 in it.
  * ```
  */
+// eslint-disable-next-line isaacscript/no-mutable-array-return
 export function newArray<T>(defaultValue: T, size: int): T[] {
   const array: T[] = [];
   repeat(size, () => {

package/src/functions/npcs.ts

@@ -66,7 +66,7 @@ export function getAliveNPCs(
   variant = -1,
   subType = -1,
   ignoreFriendly = false,
-): EntityNPC[] {
+): readonly EntityNPC[] {
   const npcs = getNPCs(entityType, variant, subType, ignoreFriendly);
   return npcs.filter((npc) => !npc.IsDead() && !isAliveExceptionNPC(npc));
 }

package/src/functions/pickups.ts

@@ -119,7 +119,7 @@ export function getKeyName(keySubType: KeySubType): string {
 }
 
 /** Helper function to get all of the red heart pickup entities in the room. */
-export function getRedHearts(): EntityPickupHeart[] {
+export function getRedHearts(): readonly EntityPickupHeart[] {
   const hearts = getHearts();
   return hearts.filter((heart) => RED_HEART_SUB_TYPES_SET.has(heart.SubType));
 }
@@ -171,7 +171,7 @@ export function isRedHeartSubType(heartSubType: HeartSubType): boolean {
  * @param cap Optional. If specified, will only remove the given amount of hearts.
  * @returns The red hearts that were removed.
  */
-export function removeAllRedHearts(cap?: int): EntityPickupHeart[] {
+export function removeAllRedHearts(cap?: int): readonly EntityPickupHeart[] {
   const redHearts = getRedHearts();
   return removeEntities(redHearts, cap);
 }

package/src/functions/pickupsSpecific.ts

@@ -23,7 +23,7 @@ import { getPickups, removeAllPickups, spawnPickup } from "./entitiesSpecific";
  */
 export function getBatteries(
   batterySubType: BatterySubType | -1 = -1,
-): EntityPickupBattery[] {
+): readonly EntityPickupBattery[] {
   return getPickups(
     PickupVariant.LIL_BATTERY,
     batterySubType,
@@ -39,7 +39,7 @@ export function getBatteries(
  */
 export function getBombPickups(
   bombSubType: BombSubType | -1 = -1,
-): EntityPickupBomb[] {
+): readonly EntityPickupBomb[] {
   return getPickups(PickupVariant.BOMB, bombSubType) as EntityPickupBomb[];
 }
 
@@ -49,7 +49,9 @@ export function getBombPickups(
  * @param cardType Optional. If specified, will only get the cards that match the sub-type. Default
  *                 is -1, which matches every sub-type.
  */
-export function getCards(cardType: CardType | -1 = -1): EntityPickupCard[] {
+export function getCards(
+  cardType: CardType | -1 = -1,
+): readonly EntityPickupCard[] {
   return getPickups(PickupVariant.CARD, cardType) as EntityPickupCard[];
 }
 
@@ -60,7 +62,7 @@ export function getCards(cardType: CardType | -1 = -1): EntityPickupCard[] {
  * @param subType Optional. If specified, will only get the chests that match the sub-type. Default
  *                is -1, which matches every sub-type.
  */
-export function getChests(subType = -1): EntityPickup[] {
+export function getChests(subType = -1): readonly EntityPickup[] {
   const chests: EntityPickup[] = [];
 
   for (const pickupVariant of CHEST_PICKUP_VARIANTS) {
@@ -79,7 +81,7 @@ export function getChests(subType = -1): EntityPickup[] {
  */
 export function getCoins(
   coinSubType: CoinSubType | -1 = -1,
-): EntityPickupCoin[] {
+): readonly EntityPickupCoin[] {
   return getPickups(PickupVariant.COIN, coinSubType) as EntityPickupCoin[];
 }
 
@@ -91,7 +93,7 @@ export function getCoins(
  */
 export function getCollectibles(
   collectibleType: CollectibleType | -1 = -1,
-): EntityPickupCollectible[] {
+): readonly EntityPickupCollectible[] {
   return getPickups(
     PickupVariant.COLLECTIBLE,
     collectibleType,
@@ -106,7 +108,7 @@ export function getCollectibles(
  */
 export function getHearts(
   heartSubType: HeartSubType | -1 = -1,
-): EntityPickupHeart[] {
+): readonly EntityPickupHeart[] {
   return getPickups(PickupVariant.HEART, heartSubType) as EntityPickupHeart[];
 }
 
@@ -116,7 +118,9 @@ export function getHearts(
  * @param keySubType Optional. If specified, will only get the keys that match the sub-type. Default
  *                   is -1, which matches every sub-type.
  */
-export function getKeys(keySubType: KeySubType | -1 = -1): EntityPickupKey[] {
+export function getKeys(
+  keySubType: KeySubType | -1 = -1,
+): readonly EntityPickupKey[] {
   return getPickups(PickupVariant.KEY, keySubType) as EntityPickupKey[];
 }
 
@@ -126,7 +130,9 @@ export function getKeys(keySubType: KeySubType | -1 = -1): EntityPickupKey[] {
  * @param pillColor Optional. If specified, will only get the pills that match the sub-type. Default
  *                  is -1, which matches every sub-type.
  */
-export function getPills(pillColor: PillColor | -1 = -1): EntityPickupPill[] {
+export function getPills(
+  pillColor: PillColor | -1 = -1,
+): readonly EntityPickupPill[] {
   return getPickups(PickupVariant.PILL, pillColor) as EntityPickupPill[];
 }
 
@@ -138,7 +144,7 @@ export function getPills(pillColor: PillColor | -1 = -1): EntityPickupPill[] {
  */
 export function getSacks(
   sackSubType: SackSubType | -1 = -1,
-): EntityPickupSack[] {
+): readonly EntityPickupSack[] {
   return getPickups(PickupVariant.SACK, sackSubType) as EntityPickupSack[];
 }
 
@@ -150,7 +156,7 @@ export function getSacks(
  */
 export function getTrinkets(
   trinketType: TrinketType | -1 = -1,
-): EntityPickupTrinket[] {
+): readonly EntityPickupTrinket[] {
   return getPickups(
     PickupVariant.TRINKET,
     trinketType,
@@ -168,7 +174,7 @@ export function getTrinkets(
 export function removeAllBatteries(
   batterySubType: BatterySubType | -1 = -1,
   cap?: int,
-): EntityPickupBattery[] {
+): readonly EntityPickupBattery[] {
   return removeAllPickups(
     PickupVariant.LIL_BATTERY,
     batterySubType,
@@ -188,7 +194,7 @@ export function removeAllBatteries(
 export function removeAllBombPickups(
   bombSubType: BombSubType | -1 = -1,
   cap?: int,
-): EntityPickupBomb[] {
+): readonly EntityPickupBomb[] {
   return removeAllPickups(
     PickupVariant.BOMB,
     bombSubType,
@@ -207,7 +213,7 @@ export function removeAllBombPickups(
 export function removeAllCards(
   cardType: CardType | -1 = -1,
   cap?: int,
-): EntityPickupCard[] {
+): readonly EntityPickupCard[] {
   return removeAllPickups(
     PickupVariant.CARD,
     cardType,
@@ -224,7 +230,10 @@ export function removeAllCards(
  * @param cap Optional. If specified, will only remove the given amount of chests.
  * @returns The chests that were removed.
  */
-export function removeAllChests(subType = -1, cap?: int): EntityPickup[] {
+export function removeAllChests(
+  subType = -1,
+  cap?: int,
+): readonly EntityPickup[] {
   const chests = getChests(subType);
   return removeEntities(chests, cap);
 }
@@ -240,7 +249,7 @@ export function removeAllChests(subType = -1, cap?: int): EntityPickup[] {
 export function removeAllCoins(
   coinSubType?: CoinSubType,
   cap?: int,
-): EntityPickupCoin[] {
+): readonly EntityPickupCoin[] {
   return removeAllPickups(
     PickupVariant.COIN,
     coinSubType,
@@ -259,7 +268,7 @@ export function removeAllCoins(
 export function removeAllCollectibles(
   collectibleType?: CollectibleType,
   cap?: int,
-): EntityPickupCollectible[] {
+): readonly EntityPickupCollectible[] {
   return removeAllPickups(
     PickupVariant.COLLECTIBLE,
     collectibleType,
@@ -278,7 +287,7 @@ export function removeAllCollectibles(
 export function removeAllHearts(
   heartSubType?: HeartSubType,
   cap?: int,
-): EntityPickupHeart[] {
+): readonly EntityPickupHeart[] {
   return removeAllPickups(
     PickupVariant.HEART,
     heartSubType,
@@ -297,7 +306,7 @@ export function removeAllHearts(
 export function removeAllKeys(
   keySubType?: KeySubType,
   cap?: int,
-): EntityPickupKey[] {
+): readonly EntityPickupKey[] {
   return removeAllPickups(
     PickupVariant.KEY,
     keySubType,
@@ -316,7 +325,7 @@ export function removeAllKeys(
 export function removeAllPills(
   pillColor?: PillColor,
   cap?: int,
-): EntityPickupPill[] {
+): readonly EntityPickupPill[] {
   return removeAllPickups(
     PickupVariant.PILL,
     pillColor,
@@ -335,7 +344,7 @@ export function removeAllPills(
 export function removeAllSacks(
   sackSubType?: SackSubType,
   cap?: int,
-): EntityPickupSack[] {
+): readonly EntityPickupSack[] {
   return removeAllPickups(
     PickupVariant.SACK,
     sackSubType,
@@ -354,7 +363,7 @@ export function removeAllSacks(
 export function removeAllTrinkets(
   trinketType?: TrinketType,
   cap?: int,
-): EntityPickupTrinket[] {
+): readonly EntityPickupTrinket[] {
   return removeAllPickups(
     PickupVariant.TRINKET,
     trinketType,

package/src/functions/playerCollectibles.ts

@@ -64,7 +64,7 @@ export function anyPlayerHasCollectible(
 export function getActiveItemSlots(
   player: EntityPlayer,
   collectibleType: CollectibleType,
-): ActiveSlot[] {
+): readonly ActiveSlot[] {
   return ACTIVE_SLOT_VALUES.filter((activeSlot) => {
     const activeItem = player.GetActiveItem(activeSlot);
     return activeItem === collectibleType;
@@ -112,7 +112,7 @@ export function getPlayerCollectibleCount(
  */
 export function getPlayersWithCollectible(
   ...collectibleTypes: CollectibleType[]
-): EntityPlayer[] {
+): readonly EntityPlayer[] {
   const players = getPlayers();
 
   return players.filter((player) =>

package/src/functions/playerEffects.ts

@@ -43,7 +43,9 @@ export function anyPlayerHasTrinketEffect(trinketType: TrinketType): boolean {
  * Helper function to get an array of temporary effects for a player. This is helpful so that you
  * don't have to manually create an array from an `EffectsList` object.
  */
-export function getEffectsList(player: EntityPlayer): TemporaryEffect[] {
+export function getEffectsList(
+  player: EntityPlayer,
+): readonly TemporaryEffect[] {
   const effects = player.GetEffects();
   const effectsList = effects.GetEffectsList();
 

package/src/functions/playerIndex.ts

@@ -22,7 +22,7 @@ const EXCLUDED_CHARACTERS = new ReadonlySet<PlayerType>([
  * This function is almost never what you want to use. For most purposes, use the `getPlayers`
  * helper function instead to get a filtered list of players.
  */
-export function getAllPlayers(): EntityPlayer[] {
+export function getAllPlayers(): readonly EntityPlayer[] {
   const numPlayers = game.GetNumPlayers();
 
   const players: EntityPlayer[] = [];
@@ -38,7 +38,7 @@ export function getAllPlayers(): EntityPlayer[] {
  * Helper function to get all of the other players in the room besides the one provided. (This
  * includes "child" players.)
  */
-export function getOtherPlayers(player: EntityPlayer): EntityPlayer[] {
+export function getOtherPlayers(player: EntityPlayer): readonly EntityPlayer[] {
   const playerPtrHash = GetPtrHash(player);
   const players = getAllPlayers();
   return players.filter(
@@ -170,7 +170,9 @@ export function getPlayerIndexVanilla(
  * @param performCharacterExclusions Whether to exclude characters that are not directly controlled
  *                                 by the player (i.e. Esau & Tainted Soul). Default is false.
  */
-export function getPlayers(performCharacterExclusions = false): EntityPlayer[] {
+export function getPlayers(
+  performCharacterExclusions = false,
+): readonly EntityPlayer[] {
   const players = getAllPlayers();
   const nonChildPlayers = players.filter((player) => !isChildPlayer(player));
   const nonChildPlayersFiltered = nonChildPlayers.filter((player) => {

package/src/functions/playerTrinkets.ts

@@ -99,7 +99,7 @@ export function getPlayerTrinkets(
  */
 export function getPlayersWithTrinket(
   ...trinketTypes: TrinketType[]
-): EntityPlayer[] {
+): readonly EntityPlayer[] {
   const players = getPlayers();
 
   return players.filter((player) =>

package/src/functions/players.ts

@@ -102,7 +102,7 @@ export function getAzazelBrimstoneDistance(
 }
 
 /** Helper function to get an array containing the characters of all of the current players. */
-export function getCharacters(): PlayerType[] {
+export function getCharacters(): readonly PlayerType[] {
   const players = getPlayers();
   return players.map((player) => player.GetPlayerType());
 }
@@ -270,7 +270,9 @@ export function getPlayerNumHitsRemaining(player: EntityPlayer): int {
  * This function is variadic, meaning that you can supply as many characters as you want to check
  * for. Returns true if any of the characters supplied are present.
  */
-export function getPlayersOfType(...characters: PlayerType[]): EntityPlayer[] {
+export function getPlayersOfType(
+  ...characters: PlayerType[]
+): readonly EntityPlayer[] {
   const charactersSet = new ReadonlySet(characters);
   const players = getPlayers();
 
@@ -288,7 +290,7 @@ export function getPlayersOfType(...characters: PlayerType[]): EntityPlayer[] {
  * Note that this function includes players with a non-undefined parent like e.g. the Strawman
  * Keeper.
  */
-export function getPlayersOnKeyboard(): EntityPlayer[] {
+export function getPlayersOnKeyboard(): readonly EntityPlayer[] {
   const players = getAllPlayers();
 
   return players.filter(
@@ -306,7 +308,7 @@ export function getPlayersOnKeyboard(): EntityPlayer[] {
  */
 export function getPlayersWithControllerIndex(
   controllerIndex: ControllerIndex,
-): EntityPlayer[] {
+): readonly EntityPlayer[] {
   const players = getAllPlayers();
   return players.filter((player) => player.ControllerIndex === controllerIndex);
 }

package/src/functions/pocketItems.ts

@@ -72,7 +72,9 @@ export function getFirstPill(
  * cannot determine the identity of a particular slot, it will mark the type of the slot as
  * `PocketItemType.UNDETERMINABLE`.
  */
-export function getPocketItems(player: EntityPlayer): PocketItemDescription[] {
+export function getPocketItems(
+  player: EntityPlayer,
+): readonly PocketItemDescription[] {
   const pocketItem = player.GetActiveItem(ActiveSlot.POCKET);
   const hasPocketItem = pocketItem !== CollectibleType.NULL;
 
@@ -171,8 +173,8 @@ export function isFirstSlotPocketActiveItem(player: EntityPlayer): boolean {
 
 /** Helper function to see if two sets of pocket item descriptions are identical. */
 export function pocketItemsEquals(
-  pocketItems1: PocketItemDescription[],
-  pocketItems2: PocketItemDescription[],
+  pocketItems1: PocketItemDescription[] | readonly PocketItemDescription[],
+  pocketItems2: PocketItemDescription[] | readonly PocketItemDescription[],
 ): boolean {
   if (pocketItems1.length !== pocketItems2.length) {
     return false;

package/src/functions/positionVelocity.ts

@@ -12,7 +12,7 @@ import { getPlayerCloserThan } from "./players";
 const MAX_FIND_FREE_POSITION_ATTEMPTS = 100;
 
 export function anyEntityCloserThan(
-  entities: Entity[],
+  entities: Entity[] | readonly Entity[],
   position: Vector,
   distance: int,
 ): boolean {
@@ -109,7 +109,9 @@ export function findFreePosition(
  *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
  *                 multiple times.
  */
-export function getEntityPositions(entities?: Entity[]): Map<PtrHash, Vector> {
+export function getEntityPositions(
+  entities?: Entity[] | readonly Entity[],
+): Map<PtrHash, Vector> {
   if (entities === undefined) {
     entities = getEntities();
   }
@@ -132,7 +134,9 @@ export function getEntityPositions(entities?: Entity[]): Map<PtrHash, Vector> {
  *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
  *                 multiple times.
  */
-export function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector> {
+export function getEntityVelocities(
+  entities?: Entity[] | readonly Entity[],
+): Map<PtrHash, Vector> {
   if (entities === undefined) {
     entities = getEntities();
   }
@@ -161,7 +165,7 @@ export function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector> {
  */
 export function setEntityPositions(
   entityPositions: Map<PtrHash, Vector>,
-  entities?: Entity[],
+  entities?: Entity[] | readonly Entity[],
 ): void {
   if (entities === undefined) {
     entities = getEntities();
@@ -191,7 +195,7 @@ export function setEntityPositions(
  */
 export function setEntityVelocities(
   entityVelocities: Map<PtrHash, Vector>,
-  entities?: Entity[],
+  entities?: Entity[] | readonly Entity[],
 ): void {
   if (entities === undefined) {
     entities = getEntities();