isaacscript-common 87.9.6 → 87.9.8

package/src/functions/gridEntitiesSpecific.ts

@@ -147,6 +147,21 @@ export function getSpikes(variant = -1): readonly GridEntitySpikes[] {
   return spikes;
 }
 
+/**
+ * Helper function to get all of the grid entities of type `GridEntityType.TELEPORTER` (23) in the
+ * room.
+ *
+ * @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): readonly GridEntity[] {
+  if (variant === -1) {
+    return getGridEntities(GridEntityType.TELEPORTER);
+  }
+
+  return getMatchingGridEntities(GridEntityType.TELEPORTER, variant);
+}
+
 /** Helper function to get all of the `GridEntityTNT` in the room. */
 export function getTNT(variant = -1): readonly GridEntityTNT[] {
   const tntArray: GridEntityTNT[] = [];
@@ -163,21 +178,6 @@ export function getTNT(variant = -1): readonly GridEntityTNT[] {
   return tntArray;
 }
 
-/**
- * Helper function to get all of the grid entities of type `GridEntityType.TELEPORTER` (23) in the
- * room.
- *
- * @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): readonly GridEntity[] {
-  if (variant === -1) {
-    return getGridEntities(GridEntityType.TELEPORTER);
-  }
-
-  return getMatchingGridEntities(GridEntityType.TELEPORTER, variant);
-}
-
 /**
  * Helper function to get all of the grid entities of type `GridEntityType.TRAPDOOR` (17) in the
  * room. Specify a specific trapdoor variant to select only trapdoors of that variant.
@@ -323,26 +323,6 @@ export function removeAllSpikes(
   return removeGridEntities(spikes, updateRoom, cap);
 }
 
-/**
- * Helper function to remove all of the `GridEntityTNT` in the room.
- *
- * @param variant Optional. If specified, will only remove the TNTs that match this variant. Default
- *                is -1, which matches every variant.
- * @param updateRoom Optional. Whether to update the room after the TNTs are removed. Default is
- *                   false. For more information, see the description of the `removeGridEntities`
- *                   helper function.
- * @param cap Optional. If specified, will only remove the given amount of TNTs.
- * @returns The TNTs that were removed.
- */
-export function removeAllTNT(
-  variant = -1,
-  updateRoom = false,
-  cap?: int,
-): readonly GridEntityTNT[] {
-  const tnt = getTNT(variant);
-  return removeGridEntities(tnt, updateRoom, cap);
-}
-
 /**
  * Helper function to remove all of the `GridEntityType.TELEPORTER` (23) in the room.
  *
@@ -363,6 +343,26 @@ export function removeAllTeleporters(
   return removeGridEntities(teleporters, updateRoom, cap);
 }
 
+/**
+ * Helper function to remove all of the `GridEntityTNT` in the room.
+ *
+ * @param variant Optional. If specified, will only remove the TNTs that match this variant. Default
+ *                is -1, which matches every variant.
+ * @param updateRoom Optional. Whether to update the room after the TNTs are removed. Default is
+ *                   false. For more information, see the description of the `removeGridEntities`
+ *                   helper function.
+ * @param cap Optional. If specified, will only remove the given amount of TNTs.
+ * @returns The TNTs that were removed.
+ */
+export function removeAllTNT(
+  variant = -1,
+  updateRoom = false,
+  cap?: int,
+): readonly GridEntityTNT[] {
+  const tnt = getTNT(variant);
+  return removeGridEntities(tnt, updateRoom, cap);
+}
+
 /**
  * Helper function to remove all of the `GridEntityType.TRAPDOOR` (17) in the room.
  *
@@ -573,6 +573,25 @@ export function spawnSpikesWithVariant(
   return spikes;
 }
 
+/** Helper function to spawn a `GridEntityType.TELEPORTER` (23). */
+export function spawnTeleporter(
+  gridIndexOrPosition: int | Vector,
+): GridEntity | undefined {
+  return spawnTeleporterWithVariant(0, gridIndexOrPosition);
+}
+
+/** Helper function to spawn a `GridEntityType.TELEPORTER` (23) with a specific variant. */
+export function spawnTeleporterWithVariant(
+  variant: int,
+  gridIndexOrPosition: int | Vector,
+): GridEntity | undefined {
+  return spawnGridEntityWithVariant(
+    GridEntityType.TELEPORTER,
+    variant,
+    gridIndexOrPosition,
+  );
+}
+
 /** Helper function to spawn a `GridEntityType.TNT` (12). */
 export function spawnTNT(
   gridIndexOrPosition: int | Vector,
@@ -600,25 +619,6 @@ export function spawnTNTWithVariant(
   return tnt;
 }
 
-/** Helper function to spawn a `GridEntityType.TELEPORTER` (23). */
-export function spawnTeleporter(
-  gridIndexOrPosition: int | Vector,
-): GridEntity | undefined {
-  return spawnTeleporterWithVariant(0, gridIndexOrPosition);
-}
-
-/** Helper function to spawn a `GridEntityType.TELEPORTER` (23) with a specific variant. */
-export function spawnTeleporterWithVariant(
-  variant: int,
-  gridIndexOrPosition: int | Vector,
-): GridEntity | undefined {
-  return spawnGridEntityWithVariant(
-    GridEntityType.TELEPORTER,
-    variant,
-    gridIndexOrPosition,
-  );
-}
-
 /** Helper function to spawn a `GridEntityType.TRAPDOOR` (17). */
 export function spawnTrapdoor(
   gridIndexOrPosition: int | Vector,

package/src/functions/hex.ts

@@ -34,29 +34,49 @@ function hexToRGB(hexString: string): { r: float; g: float; b: float } {
   hexString = hexString.replace("#", "");
   if (hexString.length !== HEX_STRING_LENGTH) {
     logError(`Hex strings must be of length: ${HEX_STRING_LENGTH}`);
-    return { r: 0, g: 0, b: 0 };
+    return {
+      r: 0,
+      g: 0,
+      b: 0,
+    };
   }
 
   const rString = hexString.slice(0, 2);
   const r = tonumber(`0x${rString}`);
   if (r === undefined) {
     logError(`Failed to convert \`0x${rString}\` to a number.`);
-    return { r: 0, g: 0, b: 0 };
+    return {
+      r: 0,
+      g: 0,
+      b: 0,
+    };
   }
 
   const gString = hexString.slice(2, 4);
   const g = tonumber(`0x${gString}`);
   if (g === undefined) {
     logError(`Failed to convert \`0x${gString}\` to a number.`);
-    return { r: 0, g: 0, b: 0 };
+    return {
+      r: 0,
+      g: 0,
+      b: 0,
+    };
   }
 
   const bString = hexString.slice(4, 6);
   const b = tonumber(`0x${bString}`);
   if (b === undefined) {
     logError(`Failed to convert \`0x${bString}\` to a number.`);
-    return { r: 0, g: 0, b: 0 };
+    return {
+      r: 0,
+      g: 0,
+      b: 0,
+    };
   }
 
-  return { r, g, b };
+  return {
+    r,
+    g,
+    b,
+  };
 }

package/src/functions/isaacAPIClass.ts

@@ -20,8 +20,7 @@ export function getIsaacAPIClassName(object: unknown): string | undefined {
   }
 
   const metatable = getmetatable(object) as
-    | LuaMap<AnyNotNil, unknown>
-    | undefined;
+    LuaMap<AnyNotNil, unknown> | undefined;
   if (metatable === undefined) {
     return undefined;
   }
@@ -34,6 +33,21 @@ export function getIsaacAPIClassName(object: unknown): string | undefined {
   return trimPrefix(classType, "const ");
 }
 
+/**
+ * Helper function to check if an instantiated Isaac API class is equal to another one of the same
+ * type. You must provide the list of keys to check for.
+ */
+export function isaacAPIClassEquals(
+  object1: unknown,
+  object2: unknown,
+  keys: readonly string[],
+): boolean {
+  const table1 = object1 as LuaMap<AnyNotNil, unknown>;
+  const table2 = object2 as LuaMap<AnyNotNil, unknown>;
+
+  return keys.every((key) => table1.get(key) === table2.get(key));
+}
+
 /** Helper function to detect if a variable is of type `EntityBomb`. */
 export function isBomb(variable: unknown): variable is EntityBomb {
   return getIsaacAPIClassName(variable) === "EntityBomb";
@@ -145,27 +159,12 @@ export function isSpikes(variable: unknown): variable is GridEntitySpikes {
   return getIsaacAPIClassName(variable) === "GridEntitySpikes";
 }
 
-/** Helper function to detect if a variable is of type `GridEntityTNT`. */
-export function isTNT(variable: unknown): variable is GridEntityTNT {
-  return getIsaacAPIClassName(variable) === "GridEntityTNT";
-}
-
 /** Helper function to detect if a variable is of type `EntityTear`. */
 export function isTear(variable: unknown): variable is EntityTear {
   return getIsaacAPIClassName(variable) === "EntityTear";
 }
 
-/**
- * Helper function to check if an instantiated Isaac API class is equal to another one of the same
- * type. You must provide the list of keys to check for.
- */
-export function isaacAPIClassEquals(
-  object1: unknown,
-  object2: unknown,
-  keys: readonly string[],
-): boolean {
-  const table1 = object1 as LuaMap<AnyNotNil, unknown>;
-  const table2 = object2 as LuaMap<AnyNotNil, unknown>;
-
-  return keys.every((key) => table1.get(key) === table2.get(key));
+/** Helper function to detect if a variable is of type `GridEntityTNT`. */
+export function isTNT(variable: unknown): variable is GridEntityTNT {
+  return getIsaacAPIClassName(variable) === "GridEntityTNT";
 }

package/src/functions/jsonHelpers.ts

@@ -1,14 +1,6 @@
 import * as jsonLua from "../lib/jsonLua";
 import { logError } from "./log";
 
-function tryDecode(this: void, jsonString: string) {
-  return jsonLua.decode(jsonString) as LuaMap<AnyNotNil, unknown>;
-}
-
-function tryEncode(this: void, luaTable: unknown) {
-  return jsonLua.encode(luaTable);
-}
-
 /**
  * Converts a JSON string to a Lua table.
  *
@@ -51,3 +43,11 @@ export function jsonEncode(luaTable: unknown): string {
 
   return jsonStringOrErrMsg;
 }
+
+function tryDecode(this: void, jsonString: string) {
+  return jsonLua.decode(jsonString) as LuaMap<AnyNotNil, unknown>;
+}
+
+function tryEncode(this: void, luaTable: unknown) {
+  return jsonLua.encode(luaTable);
+}

package/src/functions/jsonRoom.ts

@@ -12,7 +12,7 @@ import { assertDefined } from "./utils";
 
 /** This represents either a `JSONRoom` or a `JSONEntity`. */
 interface JSONObject {
-  $: { weight: string | undefined };
+  readonly $: { readonly weight: string | undefined };
 }
 
 /**
@@ -232,23 +232,6 @@ export function getRandomJSONRoom(
   return randomJSONRoom;
 }
 
-function getTotalWeightOfJSONObject(
-  jsonOjectArray: readonly JSONObject[],
-): float {
-  const weights = jsonOjectArray.map((jsonObject) => {
-    const weightString = jsonObject.$.weight;
-    const weight = tonumber(weightString);
-    assertDefined(
-      weight,
-      `Failed to parse the weight of a JSON object: ${weightString}.`,
-    );
-
-    return weight;
-  });
-
-  return sumArray(weights);
-}
-
 function getJSONObjectWithChosenWeight<T extends JSONObject>(
   jsonOjectArray: readonly T[],
   chosenWeight: float,
@@ -271,3 +254,20 @@ function getJSONObjectWithChosenWeight<T extends JSONObject>(
 
   return undefined;
 }
+
+function getTotalWeightOfJSONObject(
+  jsonOjectArray: readonly JSONObject[],
+): float {
+  const weights = jsonOjectArray.map((jsonObject) => {
+    const weightString = jsonObject.$.weight;
+    const weight = tonumber(weightString);
+    assertDefined(
+      weight,
+      `Failed to parse the weight of a JSON object: ${weightString}.`,
+    );
+
+    return weight;
+  });
+
+  return sumArray(weights);
+}

package/src/functions/kColor.ts

@@ -11,7 +11,7 @@ import {
 import { isTable } from "./types";
 import { assertDefined } from "./utils";
 
-export type SerializedKColor = LuaMap<string, unknown> & {
+export type SerializedKColor = Readonly<LuaMap<string, unknown>> & {
   readonly __serializedKColorBrand: symbol;
   readonly __kind: CopyableIsaacAPIClassType.K_COLOR;
 };

package/src/functions/levelGrid.ts

@@ -359,7 +359,7 @@ export function getRoomShapeAdjacentExistingGridIndexes(
 ): ReadonlyMap<DoorSlot, int> {
   const roomShapeAdjacentGridIndexes = copyMap(
     getRoomShapeAdjacentGridIndexes(safeRoomGridIndex, roomShape),
-  );
+  ) as Map<DoorSlot, int>;
 
   for (const [doorSlot, roomGridIndex] of roomShapeAdjacentGridIndexes) {
     const roomData = getRoomData(roomGridIndex);
@@ -425,7 +425,7 @@ export function getRoomShapeAdjacentNonExistingGridIndexes(
 ): ReadonlyMap<DoorSlot, int> {
   const roomShapeAdjacentGridIndexes = copyMap(
     getRoomShapeAdjacentGridIndexes(safeRoomGridIndex, roomShape),
-  );
+  ) as Map<DoorSlot, int>;
 
   for (const [doorSlot, roomGridIndex] of roomShapeAdjacentGridIndexes) {
     const roomData = getRoomData(roomGridIndex);
@@ -602,12 +602,7 @@ export function newRoom(
 
     if (hasFullMap) {
       roomDescriptor.DisplayFlags = ALL_DISPLAY_FLAGS;
-    } else if (!isSecretRoom && hasCompass) {
-      roomDescriptor.DisplayFlags = addFlag(
-        DisplayFlag.VISIBLE,
-        DisplayFlag.SHOW_ICON,
-      );
-    } else if (isSecretRoom && hasBlueMap) {
+    } else if ((!isSecretRoom && hasCompass) || (isSecretRoom && hasBlueMap)) {
       roomDescriptor.DisplayFlags = addFlag(
         DisplayFlag.VISIBLE,
         DisplayFlag.SHOW_ICON,

package/src/functions/logEntities.ts

@@ -154,6 +154,58 @@ export function logEntity(this: void, entity: Entity): void {
   log(msg);
 }
 
+/** Helper function for logging an array of specific grid entities. */
+export function logGridEntities(
+  this: void,
+  gridEntities: readonly GridEntity[],
+): void {
+  for (const gridEntity of gridEntities) {
+    logGridEntity(gridEntity);
+  }
+}
+
+/** Helper function for log information about a specific grid entity. */
+export function logGridEntity(this: void, gridEntity: GridEntity): void {
+  const msg = getGridEntityLogLine(gridEntity);
+  log(msg);
+}
+
+/**
+ * Helper function to log information about the entity that corresponding to a pointer hash. (Only
+ * use this when debugging, since retrieving the corresponding entity is expensive.)
+ */
+export function logPtrHash(this: void, ptrHash: PtrHash): void {
+  log(`PtrHash: ${ptrHash}`);
+  const entity = getEntityFromPtrHash(ptrHash);
+  if (entity === undefined) {
+    log("No corresponding entity found.");
+  } else {
+    logEntity(entity);
+  }
+}
+
+/**
+ * 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: readonly PtrHash[]): void {
+  for (const ptrHash of ptrHashes) {
+    logPtrHash(ptrHash);
+  }
+}
+
+function getBombVariantName(bomb: EntityBomb) {
+  // Handle modded entities.
+  const enumName = BombVariant[bomb.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `BombVariant.${enumName}`;
+}
+
+function getEffectVariantName(effect: EntityEffect) {
+  // Handle modded entities.
+  const enumName = EffectVariant[effect.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `EffectVariant.${enumName}`;
+}
+
 function getEntityLogLine(this: void, entity: Entity, num?: int): string {
   let msg = num === undefined ? "" : `${num}) `;
 
@@ -237,80 +289,16 @@ function getEntityLogLine(this: void, entity: Entity, num?: int): string {
   return msg;
 }
 
-function getBombVariantName(bomb: EntityBomb) {
-  // Handle modded entities.
-  const enumName = BombVariant[bomb.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `BombVariant.${enumName}`;
-}
-
-function getEffectVariantName(effect: EntityEffect) {
-  // Handle modded entities.
-  const enumName = EffectVariant[effect.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `EffectVariant.${enumName}`;
-}
-
-function getFamiliarVariantName(familiar: EntityFamiliar) {
-  // Handle modded entities.
-  const enumName = FamiliarVariant[familiar.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `FamiliarVariant.${enumName}`;
-}
-
-function getKnifeVariantName(knife: EntityKnife) {
-  // Handle modded entities.
-  const enumName = KnifeVariant[knife.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `KnifeVariant.${enumName}`;
-}
-
-function getLaserVariantName(laser: EntityLaser) {
-  // Handle modded entities.
-  const enumName = LaserVariant[laser.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `LaserVariant.${enumName}`;
-}
-
 function getEntityTypeName(npc: EntityNPC) {
   // Handle modded entities.
   const enumName = EntityType[npc.Type] as string | undefined;
   return enumName === undefined ? "unknown" : `EntityType.${enumName}`;
 }
 
-function getPickupVariantName(pickup: EntityPickup) {
-  // Handle modded entities.
-  const enumName = PickupVariant[pickup.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `PickupVariant.${enumName}`;
-}
-
-function getPlayerVariantName(player: EntityPlayer) {
-  // Handle modded entities.
-  const enumName = PlayerVariant[player.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `PlayerVariant.${enumName}`;
-}
-
-function getProjectileVariantName(projectile: EntityProjectile) {
-  // Handle modded entities.
-  const enumName = ProjectileVariant[projectile.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `ProjectileVariant.${enumName}`;
-}
-
-function getTearVariantName(tear: EntityTear) {
+function getFamiliarVariantName(familiar: EntityFamiliar) {
   // Handle modded entities.
-  const enumName = TearVariant[tear.Variant] as string | undefined;
-  return enumName === undefined ? "unknown" : `TearVariant.${enumName}`;
-}
-
-/** Helper function for logging an array of specific grid entities. */
-export function logGridEntities(
-  this: void,
-  gridEntities: readonly GridEntity[],
-): void {
-  for (const gridEntity of gridEntities) {
-    logGridEntity(gridEntity);
-  }
-}
-
-/** Helper function for log information about a specific grid entity. */
-export function logGridEntity(this: void, gridEntity: GridEntity): void {
-  const msg = getGridEntityLogLine(gridEntity);
-  log(msg);
+  const enumName = FamiliarVariant[familiar.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `FamiliarVariant.${enumName}`;
 }
 
 function getGridEntityLogLine(
@@ -374,26 +362,38 @@ function getGridEntityLogLine(
   return msg;
 }
 
-/**
- * Helper function to log information about the entity that corresponding to a pointer hash. (Only
- * use this when debugging, since retrieving the corresponding entity is expensive.)
- */
-export function logPtrHash(this: void, ptrHash: PtrHash): void {
-  log(`PtrHash: ${ptrHash}`);
-  const entity = getEntityFromPtrHash(ptrHash);
-  if (entity === undefined) {
-    log("No corresponding entity found.");
-  } else {
-    logEntity(entity);
-  }
+function getKnifeVariantName(knife: EntityKnife) {
+  // Handle modded entities.
+  const enumName = KnifeVariant[knife.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `KnifeVariant.${enumName}`;
 }
 
-/**
- * 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: readonly PtrHash[]): void {
-  for (const ptrHash of ptrHashes) {
-    logPtrHash(ptrHash);
-  }
+function getLaserVariantName(laser: EntityLaser) {
+  // Handle modded entities.
+  const enumName = LaserVariant[laser.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `LaserVariant.${enumName}`;
+}
+
+function getPickupVariantName(pickup: EntityPickup) {
+  // Handle modded entities.
+  const enumName = PickupVariant[pickup.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `PickupVariant.${enumName}`;
+}
+
+function getPlayerVariantName(player: EntityPlayer) {
+  // Handle modded entities.
+  const enumName = PlayerVariant[player.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `PlayerVariant.${enumName}`;
+}
+
+function getProjectileVariantName(projectile: EntityProjectile) {
+  // Handle modded entities.
+  const enumName = ProjectileVariant[projectile.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `ProjectileVariant.${enumName}`;
+}
+
+function getTearVariantName(tear: EntityTear) {
+  // Handle modded entities.
+  const enumName = TearVariant[tear.Variant] as string | undefined;
+  return enumName === undefined ? "unknown" : `TearVariant.${enumName}`;
 }

package/src/functions/logMisc.ts

@@ -152,11 +152,13 @@ export function logFlags<T extends BitFlag | BitFlag128>(
   let hasNoFlags = true;
   const entries = getEnumEntries(flagEnum);
   for (const [key, value] of entries) {
-    if (hasFlag(flags, value)) {
-      // eslint-disable-next-line @typescript-eslint/no-base-to-string
-      log(`  Has flag: ${key} (${value})`);
-      hasNoFlags = false;
+    if (!hasFlag(flags, value)) {
+      continue;
     }
+
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    log(`  Has flag: ${key} (${value})`);
+    hasNoFlags = false;
   }
 
   if (hasNoFlags) {
@@ -381,10 +383,12 @@ export function logSeedEffects(this: void): void {
   log("Logging seed effects:");
   let hasNoSeedEffects = true;
   for (const [key, seedEffect] of seedEffectEntries) {
-    if (seeds.HasSeedEffect(seedEffect)) {
-      log(`  ${key} (${seedEffect})`);
-      hasNoSeedEffects = false;
+    if (!seeds.HasSeedEffect(seedEffect)) {
+      continue;
     }
+
+    log(`  ${key} (${seedEffect})`);
+    hasNoSeedEffects = false;
   }
 
   if (hasNoSeedEffects) {
@@ -411,8 +415,8 @@ export function logSet(
   const suffix = name === undefined ? "" : ` "${name}"`;
   log(`Logging a TSTL set${suffix}:`);
 
-  const setValues = getSortedSetValues(set);
-  for (const value of setValues) {
+  const values = getSortedSetValues(set);
+  for (const value of values) {
     log(`  Value: ${value}`);
   }
 
@@ -503,7 +507,7 @@ export function logTableDifferences<K extends AnyNotNil, V>(
   const table2KeysSet = new ReadonlySet(table2Keys);
 
   const keysSet = combineSets(table1KeysSet, table2KeysSet);
-  const keys = [...keysSet.values()];
+  const keys = [...keysSet];
   keys.sort(); // eslint-disable-line @typescript-eslint/require-array-sort-compare
 
   for (const key of keys) {
@@ -546,7 +550,7 @@ export function logTableKeys(this: void, luaTable: unknown): void {
   let numElements = 0;
   iterateTableInOrder(luaTable, (key) => {
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
-    log(`${key}`);
+    log(String(key));
     numElements++;
   });
 

package/src/functions/map.ts

@@ -2,14 +2,8 @@ import type { DefaultMap } from "../classes/DefaultMap";
 import { sumArray } from "./array";
 
 /** Helper function to copy a map. (You can also use a Map constructor to accomplish this task.) */
-// eslint-disable-next-line complete/no-mutable-return
-export function copyMap<K, V>(oldMap: ReadonlyMap<K, V>): Map<K, V> {
-  const newMap = new Map<K, V>();
-  for (const [key, value] of oldMap) {
-    newMap.set(key, value);
-  }
-
-  return newMap;
+export function copyMap<K, V>(oldMap: ReadonlyMap<K, V>): ReadonlyMap<K, V> {
+  return new Map<K, V>(oldMap);
 }
 
 /**

package/src/functions/math.ts

@@ -120,7 +120,7 @@ export function lerpAngleDegrees(
 /**
  * If rounding fails, this function returns 0.
  *
- * From: http://lua-users.org/wiki/SimpleRound
+ * From: https://lua-users.org/wiki/SimpleRound
  *
  * @param num The number to round.
  * @param numDecimalPlaces Optional. Default is 0.