isaacscript-common 81.0.4 → 82.0.0

package/src/functions/logEntities.ts

@@ -142,7 +142,7 @@ export function logAllGridEntities(
 }
 
 /** Helper function for logging an array of specific entities. */
-export function logEntities(this: void, entities: Entity[]): void {
+export function logEntities(this: void, entities: readonly Entity[]): void {
   for (const entity of entities) {
     logEntity(entity);
   }
@@ -295,7 +295,10 @@ function getTearVariantName(tear: EntityTear) {
 }
 
 /** Helper function for logging an array of specific grid entities. */
-export function logGridEntities(this: void, gridEntities: GridEntity[]): void {
+export function logGridEntities(
+  this: void,
+  gridEntities: readonly GridEntity[],
+): void {
   for (const gridEntity of gridEntities) {
     logGridEntity(gridEntity);
   }
@@ -386,7 +389,7 @@ export function logPtrHash(this: void, ptrHash: PtrHash): void {
  * Helper function to log information about the entity that corresponding to one or more pointer
  * hashes. (Only use this when debugging, since retrieving the corresponding entity is expensive.)
  */
-export function logPtrHashes(this: void, ptrHashes: PtrHash[]): void {
+export function logPtrHashes(this: void, ptrHashes: readonly PtrHash[]): void {
   for (const ptrHash of ptrHashes) {
     logPtrHash(ptrHash);
   }

package/src/functions/logMisc.ts

@@ -20,6 +20,7 @@ import {
 } from "isaac-typescript-definitions";
 import { game, musicManager, sfxManager } from "../core/cachedClasses";
 import type { ReadonlyMap } from "../types/ReadonlyMap";
+import type { ReadonlyRecord } from "../types/ReadonlyRecord";
 import { ReadonlySet } from "../types/ReadonlySet";
 import { arrayToString, isArray } from "./array";
 import { getBossID } from "./bosses";
@@ -140,7 +141,7 @@ export function logEntityID(this: void, entity: Entity): void {
 export function logFlags<T extends BitFlag | BitFlag128>(
   this: void,
   flags: T | BitFlags<T>,
-  flagEnum: Record<string, T>,
+  flagEnum: ReadonlyRecord<string, T>,
   description = "",
 ): void {
   if (description !== "") {

package/src/functions/map.ts

@@ -33,6 +33,7 @@ export function defaultMapGetHash<V, A extends unknown[]>(
  * `mapSetHash` helper function.
  */
 export function defaultMapSetHash<V>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   map: Map<PtrHash, V>,
   entity: Entity,
   value: V,
@@ -78,6 +79,7 @@ export function getReversedMap<K, V>(
  * the map uses `PtrHash` as an index.
  */
 export function mapSetHash<V>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   map: Map<PtrHash, V>,
   entity: Entity,
   value: V,

package/src/functions/merge.ts

@@ -53,9 +53,9 @@ import { getTraversalDescription } from "./utils";
  */
 export function merge(
   oldObject:
-    | LuaMap<AnyNotNil, unknown>
-    | Map<AnyNotNil, unknown>
-    | Set<AnyNotNil>,
+    | Readonly<LuaMap<AnyNotNil, unknown>>
+    | ReadonlyMap<AnyNotNil, unknown>
+    | ReadonlySet<AnyNotNil>,
   newTable: LuaMap<AnyNotNil, unknown>,
   traversalDescription: string,
   classConstructors = new LuaMap<string, AnyClass>(),
@@ -131,6 +131,7 @@ function mergeSerializedArray(
 }
 
 function mergeSerializedTSTLObject(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   oldObject: Map<AnyNotNil, unknown> | Set<AnyNotNil>,
   newTable: LuaMap<AnyNotNil, unknown>,
   traversalDescription: string,

package/src/functions/npcDataStructures.ts

@@ -41,6 +41,7 @@ export function defaultMapGetNPC<V, Args extends unknown[]>(
  * `mapSetNPC` helper function.
  */
 export function defaultMapSetNPC<V>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   map: Map<PtrHash, V>,
   npc: EntityNPC,
   value: V,
@@ -53,6 +54,7 @@ export function defaultMapSetNPC<V>(
  * `Map.delete` method if you have a set of this type.
  */
 export function mapDeleteNPC(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   map: Map<PtrHash, unknown>,
   npc: EntityNPC,
 ): boolean {
@@ -81,7 +83,7 @@ export function mapDeleteNPC(
  * ```
  */
 export function mapGetNPC<V>(
-  map: Map<PtrHash, V>,
+  map: ReadonlyMap<PtrHash, V>,
   npc: EntityNPC,
 ): V | undefined {
   const ptrHash = GetPtrHash(npc);
@@ -92,7 +94,10 @@ export function mapGetNPC<V>(
  * Helper function to make using maps with an index of `PtrHash` easier. Use this instead of the
  * `Map.has` method if you have a map of this type.
  */
-export function mapHasNPC<V>(map: Map<PtrHash, V>, npc: EntityNPC): boolean {
+export function mapHasNPC<V>(
+  map: ReadonlyMap<PtrHash, V>,
+  npc: EntityNPC,
+): boolean {
   const ptrHash = GetPtrHash(npc);
   return map.has(ptrHash);
 }
@@ -118,6 +123,7 @@ export function mapHasNPC<V>(map: Map<PtrHash, V>, npc: EntityNPC): boolean {
  * ```
  */
 export function mapSetNPC<V>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   map: Map<PtrHash, V>,
   npc: EntityNPC,
   value: V,
@@ -130,6 +136,7 @@ export function mapSetNPC<V>(
  * Helper function to make using sets with an type of `PtrHash` easier. Use this instead of the
  * `Set.add` method if you have a set of this type.
  */
+// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
 export function setAddNPC(set: Set<PtrHash>, npc: EntityNPC): void {
   const ptrHash = GetPtrHash(npc);
   set.add(ptrHash);
@@ -139,6 +146,7 @@ export function setAddNPC(set: Set<PtrHash>, npc: EntityNPC): void {
  * Helper function to make using sets with an type of `PtrHash` easier. Use this instead of the
  * `Set.delete` method if you have a set of this type.
  */
+// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
 export function setDeleteNPC(set: Set<PtrHash>, npc: EntityNPC): boolean {
   const ptrHash = GetPtrHash(npc);
   return set.delete(ptrHash);
@@ -148,7 +156,7 @@ export function setDeleteNPC(set: Set<PtrHash>, npc: EntityNPC): boolean {
  * Helper function to make using sets with an type of `PtrHash` easier. Use this instead of the
  * `Set.has` method if you have a set of this type.
  */
-export function setHasNPC(set: Set<PtrHash>, npc: EntityNPC): boolean {
+export function setHasNPC(set: ReadonlySet<PtrHash>, npc: EntityNPC): boolean {
   const ptrHash = GetPtrHash(npc);
   return set.has(ptrHash);
 }

package/src/functions/playerCollectibles.ts

@@ -19,7 +19,7 @@ import { isCharacter } from "./players";
  */
 export function addCollectible(
   player: EntityPlayer,
-  ...collectibleTypes: CollectibleType[]
+  ...collectibleTypes: readonly CollectibleType[]
 ): void {
   for (const collectibleType of collectibleTypes) {
     player.AddCollectible(collectibleType);
@@ -93,7 +93,7 @@ export function getAdjustedPrice(basePrice: int): int {
  */
 export function getPlayerCollectibleCount(
   player: EntityPlayer,
-  ...collectibleTypes: CollectibleType[]
+  ...collectibleTypes: readonly CollectibleType[]
 ): int {
   let numCollectibles = 0;
   for (const collectibleType of collectibleTypes) {
@@ -111,7 +111,7 @@ export function getPlayerCollectibleCount(
  * check for. It only returns the players that have all of the collectibles.
  */
 export function getPlayersWithCollectible(
-  ...collectibleTypes: CollectibleType[]
+  ...collectibleTypes: readonly CollectibleType[]
 ): readonly EntityPlayer[] {
   const players = getPlayers();
 
@@ -150,7 +150,7 @@ export function getTotalPlayerCollectibles(
  */
 export function hasCollectible(
   player: EntityPlayer,
-  ...collectibleTypes: CollectibleType[]
+  ...collectibleTypes: readonly CollectibleType[]
 ): boolean {
   return collectibleTypes.some((collectibleType) =>
     player.HasCollectible(collectibleType),
@@ -168,7 +168,7 @@ export function hasCollectible(
 export function hasCollectibleInActiveSlot(
   player: EntityPlayer,
   collectibleType: CollectibleType,
-  ...activeSlots: ActiveSlot[]
+  ...activeSlots: readonly ActiveSlot[]
 ): boolean {
   const matchingActiveSlotsSet = new ReadonlySet(activeSlots);
   const activeItemSlots = getActiveItemSlots(player, collectibleType);
@@ -245,7 +245,7 @@ export function removeAllActiveItems(player: EntityPlayer): void {
  */
 export function removeCollectible(
   player: EntityPlayer,
-  ...collectibleTypes: CollectibleType[]
+  ...collectibleTypes: readonly CollectibleType[]
 ): void {
   for (const collectibleType of collectibleTypes) {
     player.RemoveCollectible(collectibleType);
@@ -276,7 +276,7 @@ export function removeCollectibleCostume(
  * remove.
  */
 export function removeCollectibleFromAllPlayers(
-  ...collectibleTypes: CollectibleType[]
+  ...collectibleTypes: readonly CollectibleType[]
 ): void {
   for (const player of getAllPlayers()) {
     for (const collectibleType of collectibleTypes) {

package/src/functions/playerDataStructures.ts

@@ -39,6 +39,7 @@ export function defaultMapGetPlayer<V, Args extends unknown[]>(
  * `mapSetPlayer` helper function.
  */
 export function defaultMapSetPlayer<V>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   map: Map<PlayerIndex, V>,
   player: EntityPlayer,
   value: V,
@@ -51,6 +52,7 @@ export function defaultMapSetPlayer<V>(
  * `Map.delete` method if you have a set of this type.
  */
 export function mapDeletePlayer(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   map: Map<PlayerIndex, unknown>,
   player: EntityPlayer,
 ): boolean {
@@ -79,7 +81,7 @@ export function mapDeletePlayer(
  * ```
  */
 export function mapGetPlayer<V>(
-  map: Map<PlayerIndex, V>,
+  map: ReadonlyMap<PlayerIndex, V>,
   player: EntityPlayer,
 ): V | undefined {
   const playerIndex = getPlayerIndex(player);
@@ -91,7 +93,7 @@ export function mapGetPlayer<V>(
  * `Map.has` method if you have a map of this type.
  */
 export function mapHasPlayer<V>(
-  map: Map<PlayerIndex, V>,
+  map: ReadonlyMap<PlayerIndex, V>,
   player: EntityPlayer,
 ): boolean {
   const playerIndex = getPlayerIndex(player);
@@ -119,6 +121,7 @@ export function mapHasPlayer<V>(
  * ```
  */
 export function mapSetPlayer<V>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   map: Map<PlayerIndex, V>,
   player: EntityPlayer,
   value: V,
@@ -132,6 +135,7 @@ export function mapSetPlayer<V>(
  * `Set.add` method if you have a set of this type.
  */
 export function setAddPlayer(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   set: Set<PlayerIndex>,
   player: EntityPlayer,
 ): void {
@@ -144,6 +148,7 @@ export function setAddPlayer(
  * `Set.delete` method if you have a set of this type.
  */
 export function setDeletePlayer(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   set: Set<PlayerIndex>,
   player: EntityPlayer,
 ): boolean {
@@ -156,7 +161,7 @@ export function setDeletePlayer(
  * `Set.has` method if you have a set of this type.
  */
 export function setHasPlayer(
-  set: Set<PlayerIndex>,
+  set: ReadonlySet<PlayerIndex>,
   player: EntityPlayer,
 ): boolean {
   const playerIndex = getPlayerIndex(player);

package/src/functions/playerTrinkets.ts

@@ -98,7 +98,7 @@ export function getPlayerTrinkets(
  * for. It only returns the players that have all of the trinkets.
  */
 export function getPlayersWithTrinket(
-  ...trinketTypes: TrinketType[]
+  ...trinketTypes: readonly TrinketType[]
 ): readonly EntityPlayer[] {
   const players = getPlayers();
 
@@ -143,7 +143,7 @@ export function hasOpenTrinketSlot(player: EntityPlayer): boolean {
  */
 export function hasTrinket(
   player: EntityPlayer,
-  ...trinketTypes: TrinketType[]
+  ...trinketTypes: readonly TrinketType[]
 ): boolean {
   return trinketTypes.some((trinketType) => player.HasTrinket(trinketType));
 }

package/src/functions/players.ts

@@ -34,7 +34,9 @@ export function anyPlayerHoldingItem(): boolean {
  * 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 anyPlayerIs(...matchingCharacters: PlayerType[]): boolean {
+export function anyPlayerIs(
+  ...matchingCharacters: readonly PlayerType[]
+): boolean {
   const matchingCharacterSet = new ReadonlySet(matchingCharacters);
   const characters = getCharacters();
 
@@ -271,7 +273,7 @@ export function getPlayerNumHitsRemaining(player: EntityPlayer): int {
  * for. Returns true if any of the characters supplied are present.
  */
 export function getPlayersOfType(
-  ...characters: PlayerType[]
+  ...characters: readonly PlayerType[]
 ): readonly EntityPlayer[] {
   const charactersSet = new ReadonlySet(characters);
   const players = getPlayers();
@@ -321,7 +323,7 @@ export function getPlayersWithControllerIndex(
  */
 export function hasForm(
   player: EntityPlayer,
-  ...playerForms: PlayerForm[]
+  ...playerForms: readonly PlayerForm[]
 ): boolean {
   return playerForms.some((playerForm) => player.HasPlayerForm(playerForm));
 }
@@ -379,7 +381,7 @@ export function isBethany(player: EntityPlayer): boolean {
  */
 export function isCharacter(
   player: EntityPlayer,
-  ...characters: PlayerType[]
+  ...characters: readonly PlayerType[]
 ): boolean {
   const characterSet = new ReadonlySet(characters);
   const character = player.GetPlayerType();

package/src/functions/rng.ts

@@ -1,6 +1,7 @@
 import type { CopyableIsaacAPIClassType } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { SerializationBrand } from "../enums/private/SerializationBrand";
+import type { ReadonlyRecord } from "../types/ReadonlyRecord";
 import { traceback } from "./debugFunctions";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
 import { logError } from "./log";
@@ -121,7 +122,10 @@ export function serializeRNG(rng: RNG): SerializedRNG {
  * Helper function to iterate over the provided object and set the seed for all of the values that
  * are RNG objects equal to a particular seed.
  */
-export function setAllRNGToSeed(object: unknown, seed: Seed): void {
+export function setAllRNGToSeed(
+  object: ReadonlyRecord<string, RNG>,
+  seed: Seed,
+): void {
   if (!isTable(object)) {
     error(
       `Failed to iterate over the object containing RNG objects since the type of the provided object was: ${typeof object}`,
@@ -147,7 +151,9 @@ export function setAllRNGToSeed(object: unknown, seed: Seed): void {
  * Helper function to iterate over the provided object and set the seed for all of the values that
  * are RNG objects equal to the start seed for the current run.
  */
-export function setAllRNGToStartSeed(object: unknown): void {
+export function setAllRNGToStartSeed(
+  object: ReadonlyRecord<string, RNG>,
+): void {
   const seeds = game.GetSeeds();
   const startSeed = seeds.GetStartSeed();
 

package/src/functions/rooms.ts

@@ -472,7 +472,7 @@ export function inMirrorRoom(): boolean {
  *
  * This function is variadic, which means you can pass as many room shapes as you want to match for.
  */
-export function inRoomShape(...roomShapes: RoomShape[]): boolean {
+export function inRoomShape(...roomShapes: readonly RoomShape[]): boolean {
   const roomData = getRoomData();
   return isRoomShape(roomData, ...roomShapes);
 }
@@ -482,7 +482,7 @@ export function inRoomShape(...roomShapes: RoomShape[]): boolean {
  *
  * This function is variadic, which means you can pass as many room types as you want to match for.
  */
-export function inRoomType(...roomTypes: RoomType[]): boolean {
+export function inRoomType(...roomTypes: readonly RoomType[]): boolean {
   const roomData = getRoomData();
   return isRoomType(roomData, ...roomTypes);
 }
@@ -806,7 +806,7 @@ export function isMirrorRoom(roomData: RoomConfig): boolean {
  */
 export function isRoomShape(
   roomData: RoomConfig,
-  ...roomShapes: RoomShape[]
+  ...roomShapes: readonly RoomShape[]
 ): boolean {
   return roomShapes.includes(roomData.Shape);
 }
@@ -818,7 +818,7 @@ export function isRoomShape(
  */
 export function isRoomType(
   roomData: RoomConfig,
-  ...roomTypes: RoomType[]
+  ...roomTypes: readonly RoomType[]
 ): boolean {
   return roomTypes.includes(roomData.Type);
 }

package/src/functions/run.ts

@@ -10,7 +10,9 @@ import { log } from "./log";
 import { isString } from "./types";
 
 /** Alias for the `anySeedEffectEnabled` function. */
-export function anyEasterEggEnabled(exceptions?: SeedEffect[]): boolean {
+export function anyEasterEggEnabled(
+  exceptions?: readonly SeedEffect[],
+): boolean {
   return anySeedEffectEnabled(exceptions);
 }
 
@@ -19,7 +21,9 @@ export function anyEasterEggEnabled(exceptions?: SeedEffect[]): boolean {
  *
  * @param exceptions Optional. An array of seed effects to ignore.
  */
-export function anySeedEffectEnabled(exceptions?: SeedEffect[]): boolean {
+export function anySeedEffectEnabled(
+  exceptions?: readonly SeedEffect[],
+): boolean {
   const seeds = game.GetSeeds();
 
   if (exceptions === undefined) {

package/src/functions/set.ts

@@ -9,6 +9,7 @@ import { isPrimitive } from "./types";
  * This function is variadic, meaning that you can specify N sets to add to the first set.
  */
 export function addSetsToSet<T>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   mainSet: Set<T>,
   ...setsToAdd: ReadonlyArray<ReadonlySet<T>>
 ): void {
@@ -54,6 +55,7 @@ export function copySet<T>(oldSet: ReadonlySet<T>): Set<T> {
  * This function is variadic, meaning that you can specify N sets to remove from the first set.
  */
 export function deleteSetsFromSet<T>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   mainSet: Set<T>,
   ...setsToRemove: ReadonlyArray<ReadonlySet<T>>
 ): void {
@@ -217,6 +219,7 @@ export function objectValuesToSet<K extends string | number | symbol, V>(
  *
  * This function is variadic, meaning that you can pass as many things as you want to add.
  */
+// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
 export function setAdd<T>(set: Set<T>, ...elements: readonly T[]): void {
   for (const element of elements) {
     set.add(element);

package/src/functions/sort.ts

@@ -88,7 +88,10 @@ export function sortObjectArrayByKey(key: string) {
  * From:
  * https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
  */
-export function sortTwoDimensionalArray<T>(a: T[], b: T[]): -1 | 0 | 1 {
+export function sortTwoDimensionalArray<T>(
+  a: readonly T[],
+  b: readonly T[],
+): -1 | 0 | 1 {
   const aType = type(a);
   const bType = type(b);
   if (aType !== bType) {
@@ -148,6 +151,7 @@ export function sortTwoDimensionalArray<T>(a: T[], b: T[]): -1 | 0 | 1 {
  */
 // eslint-disable-next-line isaacscript/no-mutable-return
 export function stableSort<T>(
+  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
   array: T[],
   sortFunc: (a: T, b: T) => -1 | 0 | 1 = sortNormal,
 ): T[] {

package/src/functions/stage.ts

@@ -362,7 +362,9 @@ export function onDarkRoom(): boolean {
  *
  * This function is variadic, which means you can pass as many stages as you want to match for.
  */
-export function onEffectiveStage(...effectiveStages: LevelStage[]): boolean {
+export function onEffectiveStage(
+  ...effectiveStages: readonly LevelStage[]
+): boolean {
   const thisEffectiveStage = getEffectiveStage();
   return effectiveStages.includes(thisEffectiveStage);
 }
@@ -422,7 +424,7 @@ export function onSheol(): boolean {
  *
  * This function is variadic, which means you can pass as many stages as you want to match for.
  */
-export function onStage(...stages: LevelStage[]): boolean {
+export function onStage(...stages: readonly LevelStage[]): boolean {
   const level = game.GetLevel();
   const thisStage = level.GetStage();
   return stages.includes(thisStage);
@@ -447,7 +449,7 @@ export function onStageOrLower(stage: LevelStage): boolean {
  *
  * This function is variadic, which means you can pass as many room types as you want to match for.
  */
-export function onStageType(...stageTypes: StageType[]): boolean {
+export function onStageType(...stageTypes: readonly StageType[]): boolean {
   const level = game.GetLevel();
   const thisStageType = level.GetStageType();
   return stageTypes.includes(thisStageType);

package/src/functions/string.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyRecord } from "../types/ReadonlyRecord";
 import { parseIntSafe } from "./types";
 import { assertDefined } from "./utils";
 
@@ -81,7 +82,7 @@ export function getMapPartialMatch<T>(
  */
 export function getObjectPartialMatch<T>(
   searchText: string,
-  object: Record<string, T>,
+  object: ReadonlyRecord<string, T>,
 ): [string, T] | undefined {
   const keys = Object.keys(object);
 
@@ -204,7 +205,7 @@ export function removeNonAlphanumericCharacters(str: string): string {
  */
 export function removeSubstring(
   string: string,
-  ...substrings: string[]
+  ...substrings: readonly string[]
 ): string {
   for (const substring of substrings) {
     string = string.replaceAll(substring, "");

package/src/functions/table.ts

@@ -43,7 +43,7 @@ export function copyUserdataValuesToTable(
 export function getBooleansFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
-  ...keys: string[]
+  ...keys: readonly string[]
 ): readonly boolean[] {
   const booleans: boolean[] = [];
   for (const key of keys) {
@@ -75,7 +75,7 @@ export function getBooleansFromTable(
 export function getNumbersFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
-  ...keys: string[]
+  ...keys: readonly string[]
 ): readonly number[] {
   const numbers: number[] = [];
   for (const key of keys) {
@@ -114,7 +114,7 @@ export function getNumbersFromTable(
 export function getStringsFromTable(
   luaMap: LuaMap<string, unknown>,
   objectName: string,
-  ...keys: string[]
+  ...keys: readonly string[]
 ): readonly string[] {
   const strings: string[] = [];
   for (const key of keys) {
@@ -204,7 +204,7 @@ export function iterateTableInOrder<K extends AnyNotNil, V>(
  */
 export function tableHasKeys(
   luaMap: LuaMap<AnyNotNil, unknown>,
-  ...keys: string[]
+  ...keys: readonly string[]
 ): boolean {
   return keys.every((key) => luaMap.has(key));
 }

package/src/functions/trinketGive.ts

@@ -88,7 +88,7 @@ export function smeltTrinket(
  */
 export function smeltTrinkets(
   player: EntityPlayer,
-  ...trinketTypes: TrinketType[]
+  ...trinketTypes: readonly TrinketType[]
 ): void {
   for (const trinketType of trinketTypes) {
     smeltTrinket(player, trinketType);

package/src/functions/utils.ts

@@ -228,4 +228,4 @@ export function repeat(num: int, func: (i: int) => void): void {
  * @allowEmptyVariadic
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
-export function todo(...args: unknown[]): void {}
+export function todo(...args: readonly unknown[]): void {}

package/src/functions/vector.ts

@@ -86,7 +86,7 @@ export function doesVectorHaveLength(
  */
 export function getClosestVectorTo(
   referenceVector: Vector,
-  vectors: Vector[],
+  vectors: readonly Vector[],
 ): Vector | undefined {
   let closestVector: Vector | undefined;
   let closestDistance = math.huge;

package/src/functions/weighted.ts

@@ -17,7 +17,7 @@ import { assertDefined } from "./utils";
  *                  a random seed.
  */
 export function getRandomFromWeightedArray<T>(
-  weightedArray: WeightedArray<T>,
+  weightedArray: Readonly<WeightedArray<T>>,
   seedOrRNG: Seed | RNG | undefined,
 ): T {
   const randomIndex = getRandomIndexFromWeightedArray(weightedArray, seedOrRNG);
@@ -45,7 +45,7 @@ export function getRandomFromWeightedArray<T>(
  *                  a random seed.
  */
 export function getRandomIndexFromWeightedArray<T>(
-  weightedArray: WeightedArray<T>,
+  weightedArray: Readonly<WeightedArray<T>>,
   seedOrRNG: Seed | RNG | undefined,
 ): int {
   if (weightedArray.length === 0) {

package/src/index.ts

@@ -185,6 +185,7 @@ export * from "./types/PlayerIndex";
 export * from "./types/PossibleStatType";
 export * from "./types/PublicInterface";
 export * from "./types/ReadonlyMap";
+export * from "./types/ReadonlyRecord";
 export * from "./types/ReadonlySet";
 export * from "./types/StartsWithLowercase";
 export * from "./types/StartsWithUppercase";