isaacscript-common 20.3.0 → 20.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "20.3.0",
+  "version": "20.3.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^10.1.5"
+    "isaac-typescript-definitions": "^11.0.0"
   }
 }

package/src/classes/ModUpgradedBase.ts

@@ -390,7 +390,7 @@ export class ModUpgradedBase implements Mod {
   /**
    * Returns the names of the exported class methods from the features that were added. This is
    * called from the "upgradeMod" function, but we want to mark it as private so that end-users
-   * don't have access to it..
+   * don't have access to it.
    */
   private initOptionalFeature(feature: ISCFeature): FunctionTuple[] {
     const featureClass = this.features[feature];

package/src/classes/callbacks/PostTrinketBreak.ts

@@ -11,10 +11,10 @@ import { PlayerIndex } from "../../types/PlayerIndex";
 import { DefaultMap } from "../DefaultMap";
 import { CustomCallback } from "../private/CustomCallback";
 
-const TRINKETS_THAT_CAN_BREAK: readonly TrinketType[] = [
+const TRINKETS_THAT_CAN_BREAK = [
   TrinketType.WISH_BONE,
   TrinketType.WALNUT,
-];
+] as const;
 
 export class PostTrinketBreak extends CustomCallback<ModCallbackCustom.POST_TRINKET_BREAK> {
   public override v = {

package/src/classes/features/callbackLogic/CustomGridEntities.ts

@@ -126,7 +126,7 @@ export class CustomGridEntities extends Feature {
     }
 
     const room = game.GetRoom();
-    for (const [gridIndex, data] of roomCustomGridEntities.entries()) {
+    for (const [gridIndex, data] of roomCustomGridEntities) {
       const decoration = room.GetGridEntity(gridIndex);
       if (decoration === undefined) {
         roomCustomGridEntities.delete(gridIndex);
@@ -361,7 +361,7 @@ export class CustomGridEntities extends Feature {
 
     const room = game.GetRoom();
     const customGridEntities: Array<[GridEntity, GridEntityCustomData]> = [];
-    for (const [gridIndex, data] of roomCustomGridEntities.entries()) {
+    for (const [gridIndex, data] of roomCustomGridEntities) {
       const gridEntity = room.GetGridEntity(gridIndex);
       if (gridEntity !== undefined) {
         customGridEntities.push([gridEntity, data]);
@@ -398,7 +398,7 @@ export class CustomGridEntities extends Feature {
       return undefined;
     }
 
-    for (const [_gridIndex, data] of roomCustomGridEntities.entries()) {
+    for (const [_gridIndex, data] of roomCustomGridEntities) {
       if (data.gridIndex === gridIndex) {
         return data.gridEntityTypeCustom;
       }

package/src/classes/features/callbackLogic/GridEntityCollisionDetection.ts

@@ -77,7 +77,7 @@ export class GridEntityCollisionDetection extends Feature {
         GetPtrHash(entity),
       );
       const collidingEntitiesPtrHashSet = new Set(collidingEntitiesPtrHashes);
-      for (const oldCollidingEntityPtrHash of oldCollidingEntities.values()) {
+      for (const oldCollidingEntityPtrHash of oldCollidingEntities) {
         if (!collidingEntitiesPtrHashSet.has(oldCollidingEntityPtrHash)) {
           oldCollidingEntities.delete(oldCollidingEntityPtrHash);
         }

package/src/classes/features/callbackLogic/GridEntityUpdateDetection.ts

@@ -91,7 +91,7 @@ export class GridEntityUpdateDetection extends Feature {
     // being removed and fire the PostGridEntityRemoved callback.
     this.checkGridEntitiesRemoved(gridEntitiesMap);
 
-    for (const [gridIndex, gridEntity] of gridEntitiesMap.entries()) {
+    for (const [gridIndex, gridEntity] of gridEntitiesMap) {
       this.checkGridEntityStateChanged(gridIndex, gridEntity);
       this.checkNewGridEntity(gridIndex, gridEntity);
 
@@ -108,10 +108,8 @@ export class GridEntityUpdateDetection extends Feature {
   private checkGridEntitiesRemoved(
     gridEntitiesMap: Map<int, GridEntity>,
   ): void {
-    for (const [
-      gridIndex,
-      gridEntityTuple,
-    ] of this.v.room.initializedGridEntities.entries()) {
+    for (const [gridIndex, gridEntityTuple] of this.v.room
+      .initializedGridEntities) {
       const [storedGridEntityType, storedGridEntityVariant] = gridEntityTuple;
       const gridEntity = gridEntitiesMap.get(gridIndex);
       if (
@@ -213,7 +211,7 @@ export class GridEntityUpdateDetection extends Feature {
   private postNewRoomReordered = (): void => {
     const gridEntitiesMap = getGridEntitiesMap();
 
-    for (const [gridIndex, gridEntity] of gridEntitiesMap.entries()) {
+    for (const [gridIndex, gridEntity] of gridEntitiesMap) {
       this.checkNewGridEntity(gridIndex, gridEntity);
     }
   };

package/src/classes/features/callbackLogic/PlayerCollectibleDetection.ts

@@ -109,7 +109,7 @@ export class PlayerCollectibleDetection extends Feature {
     ]);
 
     let numFired = 0;
-    for (const collectibleType of collectibleTypesSet.values()) {
+    for (const collectibleType of collectibleTypesSet) {
       const oldNum = oldCollectibleMap.get(collectibleType) ?? 0;
       const newNum = newCollectibleMap.get(collectibleType) ?? 0;
       const difference = newNum - oldNum;

package/src/classes/features/other/CustomHotkeys.ts

@@ -34,17 +34,11 @@ export class CustomHotkeys extends Feature {
 
   // ModCallback.POST_RENDER (2)
   private postRender = () => {
-    for (const [
-      keyboard,
-      triggerFunc,
-    ] of this.staticHotkeyFunctionMap.entries()) {
+    for (const [keyboard, triggerFunc] of this.staticHotkeyFunctionMap) {
       this.checkIfTriggered(keyboard, triggerFunc);
     }
 
-    for (const [
-      keyboardFunc,
-      triggerFunc,
-    ] of this.dynamicHotkeyFunctionMap.entries()) {
+    for (const [keyboardFunc, triggerFunc] of this.dynamicHotkeyFunctionMap) {
       const keyboard = keyboardFunc();
       if (keyboard !== undefined) {
         this.checkIfTriggered(keyboard, triggerFunc);

package/src/classes/features/other/DeployJSONRoom.ts

@@ -304,7 +304,7 @@ function fixPitGraphics() {
   const gridWidth = room.GetGridWidth();
   const pitMap = getPitMap();
 
-  for (const [gridIndex, gridEntity] of pitMap.entries()) {
+  for (const [gridIndex, gridEntity] of pitMap) {
     const gridIndexLeft = gridIndex - 1;
     const L = pitMap.has(gridIndexLeft);
     const gridIndexRight = gridIndex + 1;

package/src/classes/features/other/FlyingDetection.ts

@@ -4,11 +4,11 @@ import { ISCFeature } from "../../../enums/ISCFeature";
 import { Feature } from "../../private/Feature";
 import { ModdedElementSets } from "./ModdedElementSets";
 
-const FLYING_NULL_ITEMS: readonly NullItemID[] = [
+const FLYING_NULL_ITEMS = [
   NullItemID.REVERSE_SUN, // 66
   NullItemID.SPIRIT_SHACKLES_SOUL, // 10
   NullItemID.LOST_CURSE, // 112
-];
+] as const;
 
 export class FlyingDetection extends Feature {
   private moddedElementSets: ModdedElementSets;

package/src/classes/features/other/ItemPoolDetection.ts

@@ -25,15 +25,13 @@ import { ModdedElementSets } from "./ModdedElementSets";
 
 const COLLECTIBLE_TYPE_THAT_IS_NOT_IN_ANY_POOLS = CollectibleType.KEY_PIECE_1;
 
-const COLLECTIBLES_THAT_AFFECT_ITEM_POOLS: readonly CollectibleType[] = [
+const COLLECTIBLES_THAT_AFFECT_ITEM_POOLS = [
   CollectibleType.CHAOS, // 402
   CollectibleType.SACRED_ORB, // 691
   CollectibleType.TMTRAINER, // 721
-];
+] as const;
 
-const TRINKETS_THAT_AFFECT_ITEM_POOLS: readonly TrinketType[] = [
-  TrinketType.NO,
-];
+const TRINKETS_THAT_AFFECT_ITEM_POOLS = [TrinketType.NO] as const;
 
 export class ItemPoolDetection extends Feature {
   private moddedElementSets: ModdedElementSets;

package/src/classes/features/other/ModdedElementSets.ts

@@ -43,12 +43,12 @@ import { repeat } from "../../../functions/utils";
 import { Feature } from "../../private/Feature";
 import { ModdedElementDetection } from "./ModdedElementDetection";
 
-const CONDITIONAL_FLYING_COLLECTIBLE_TYPES: readonly CollectibleType[] = [
+const CONDITIONAL_FLYING_COLLECTIBLE_TYPES = [
   CollectibleType.BIBLE,
   CollectibleType.EMPTY_VESSEL,
   CollectibleType.ASTRAL_PROJECTION,
   CollectibleType.RECALL,
-];
+] as const;
 
 const TRANSFORMATION_TO_TAG_MAP: ReadonlyMap<PlayerForm, ItemConfigTag> =
   new Map([
@@ -366,7 +366,7 @@ export class ModdedElementSets extends Feature {
     for (const collectibleType of CONDITIONAL_FLYING_COLLECTIBLE_TYPES) {
       permanentFlyingCollectibleTypes.delete(collectibleType);
     }
-    for (const collectibleType of permanentFlyingCollectibleTypes.values()) {
+    for (const collectibleType of permanentFlyingCollectibleTypes) {
       this.permanentFlyingCollectibleTypesSet.add(collectibleType);
     }
   }
@@ -514,7 +514,7 @@ export class ModdedElementSets extends Feature {
         );
       }
 
-      for (const cardType of cardTypeSet.values()) {
+      for (const cardType of cardTypeSet) {
         matchingCardTypes.add(cardType);
       }
     }

package/src/classes/features/other/PersistentEntities.ts

@@ -170,10 +170,7 @@ export class PersistentEntities extends Feature {
   ): void {
     this.v.level.persistentEntities.delete(persistentEntityIndex);
 
-    for (const [
-      ptrHash,
-      tuple,
-    ] of this.v.room.spawnedPersistentEntities.entries()) {
+    for (const [ptrHash, tuple] of this.v.room.spawnedPersistentEntities) {
       const [index, entityPtr] = tuple;
       if (index !== persistentEntityIndex) {
         continue;

package/src/classes/features/other/PickupIndexCreation.ts

@@ -275,7 +275,7 @@ function getStoredPickupIndex(
   pickup: Entity,
   pickupDescriptions: Map<PickupIndex, PickupDescription>,
 ): PickupIndex | undefined {
-  for (const [pickupIndex, pickupDescription] of pickupDescriptions.entries()) {
+  for (const [pickupIndex, pickupDescription] of pickupDescriptions) {
     if (
       vectorEquals(pickupDescription.position, pickup.Position) &&
       pickupDescription.initSeed === pickup.InitSeed

package/src/classes/features/other/PonyDetection.ts

@@ -11,11 +11,11 @@ import { getPlayers } from "../../../functions/playerIndex";
 import { PlayerIndex } from "../../../types/PlayerIndex";
 import { Feature } from "../../private/Feature";
 
-const FLAGS_WHEN_PONY_IS_ACTIVE: readonly EntityFlag[] = [
+const FLAGS_WHEN_PONY_IS_ACTIVE = [
   EntityFlag.NO_KNOCKBACK, // 1 << 26
   EntityFlag.NO_PHYSICS_KNOCKBACK, // 1 << 30
   EntityFlag.NO_DAMAGE_BLINK, // 1 << 36
-];
+] as const;
 
 export class PonyDetection extends Feature {
   /** @internal */

package/src/classes/features/other/customStages/backdrop.ts

@@ -72,10 +72,10 @@ const ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS: {
 const WALL_OFFSET = Vector(-80, -80);
 
 /** Corresponds to "floor-backdrop.anm2". */
-const L_FLOOR_ANM2_LAYERS: readonly int[] = [16, 17];
+const L_FLOOR_ANM2_LAYERS = [16, 17] as const;
 
 /** Corresponds to "floor-backdrop.anm2". */
-const N_FLOOR_ANM2_LAYERS: readonly int[] = [18, 19];
+const N_FLOOR_ANM2_LAYERS = [18, 19] as const;
 
 /**
  * Normally, we would make a custom entity to represent a backdrop effect, but we don't want to

package/src/classes/features/other/customStages/streakText.ts

@@ -49,10 +49,12 @@ const STREAK_TEXT_BOTTOM_Y_OFFSET = -9;
 const NUM_RENDER_FRAMES_MAP_HELD_BEFORE_STREAK_TEXT = 11;
 
 /** Taken from StageAPI. */
-const TEXT_IN_ADJUSTMENTS = [-800, -639, -450, -250, -70, 10, 6, 3];
+const TEXT_IN_ADJUSTMENTS = [-800, -639, -450, -250, -70, 10, 6, 3] as const;
 
 /** Taken from StageAPI. */
-const TEXT_OUT_ADJUSTMENTS = [0, -5, -10, -15, -20, 144, 308, 472, 636, 800];
+const TEXT_OUT_ADJUSTMENTS = [
+  0, -5, -10, -15, -20, 144, 308, 472, 636, 800,
+] as const;
 
 /** Taken from StageAPI. */
 const TEXT_IN_SCALES = [
@@ -64,7 +66,7 @@ const TEXT_IN_SCALES = [
   Vector(0.95, 1.05),
   Vector(0.97, 1.03),
   Vector(0.98, 1.02),
-];
+] as const;
 
 /** Taken from StageAPI. */
 const TEXT_OUT_SCALES = [
@@ -78,7 +80,7 @@ const TEXT_OUT_SCALES = [
   Vector(2.18, 0.56),
   Vector(2.59, 0.38),
   Vector(3, 0.2),
-];
+] as const;
 
 interface StreakTextVars {
   run: {

package/src/classes/features/other/saveDataManager/glowingHourGlass.ts

@@ -14,10 +14,10 @@ import { SAVE_DATA_MANAGER_DEBUG } from "./constants";
  * When the Glowing Hourglass is used, certain save data keys will automatically be restored to a
  * backup.
  */
-const GLOWING_HOUR_GLASS_BACKUP_KEYS: readonly SaveDataKey[] = [
+const GLOWING_HOUR_GLASS_BACKUP_KEYS = [
   SaveDataKey.RUN,
   SaveDataKey.LEVEL,
-];
+] as const;
 
 const IGNORE_GLOWING_HOUR_GLASS_KEY = "__ignoreGlowingHourGlass";
 

package/src/core/constants.ts

@@ -79,12 +79,13 @@ export const GAME_FRAMES_PER_SECOND = 30;
 export const GAME_FRAMES_PER_MINUTE = GAME_FRAMES_PER_SECOND * 60;
 
 /** The set of all `ItemConfigCardType` values that are not a rune or special object. */
-export const ITEM_CONFIG_CARD_TYPES_FOR_CARDS = new Set([
-  ItemConfigCardType.TAROT,
-  ItemConfigCardType.SUIT,
-  ItemConfigCardType.SPECIAL,
-  ItemConfigCardType.TAROT_REVERSE,
-]);
+export const ITEM_CONFIG_CARD_TYPES_FOR_CARDS: ReadonlySet<ItemConfigCardType> =
+  new Set([
+    ItemConfigCardType.TAROT,
+    ItemConfigCardType.SUIT,
+    ItemConfigCardType.SPECIAL,
+    ItemConfigCardType.TAROT_REVERSE,
+  ]);
 
 /** Render frames are what is returned by the `Isaac.GetFrameCount` method. */
 export const RENDER_FRAMES_PER_SECOND = 60;

package/src/functions/bitSet128.ts

@@ -14,7 +14,7 @@ export type SerializedBitSet128 = LuaMap<string, unknown> & {
 };
 
 const OBJECT_NAME = "BitSet128";
-const KEYS = ["l", "h"];
+const KEYS = ["l", "h"] as const;
 
 /** Helper function to copy a `BitSet128` Isaac API class. */
 export function copyBitSet128(bitSet128: BitSet128): BitSet128 {

package/src/functions/color.ts

@@ -16,7 +16,7 @@ export type SerializedColor = LuaMap<string, unknown> & {
 };
 
 const OBJECT_NAME = "Color";
-const KEYS = ["R", "G", "B", "A", "RO", "GO", "BO"];
+const KEYS = ["R", "G", "B", "A", "RO", "GO", "BO"] as const;
 
 export function colorEquals(color1: Color, color2: Color): boolean {
   return isaacAPIClassEquals(color1, color2, KEYS);

package/src/functions/hex.ts

@@ -6,8 +6,9 @@ const HEX_STRING_LENGTH = 6;
  * Converts a hex string like "#33aa33" to a KColor object.
  *
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+ * @param alpha Optional. Range is from 0 to 1. Default is 1. (The same as the `Color` constructor.)
  */
-export function hexToColor(hexString: string, alpha: float): Color {
+export function hexToColor(hexString: string, alpha = 1.0): Color {
   const [r, g, b] = hexToRGB(hexString);
 
   // Color values should be between 0 and 1.
@@ -19,8 +20,9 @@ export function hexToColor(hexString: string, alpha: float): Color {
  * Converts a hex string like "#33aa33" to a Color object.
  *
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+ * @param alpha Range is from 0 to 1. Default is 1.
  */
-export function hexToKColor(hexString: string, alpha: float): KColor {
+export function hexToKColor(hexString: string, alpha = 1.0): KColor {
   const [r, g, b] = hexToRGB(hexString);
 
   // KColor values should be between 0 and 1.

package/src/functions/input.ts

@@ -8,7 +8,7 @@ import { KEYBOARD_TO_STRING } from "../maps/keyboardToString";
 import { getEnumValues } from "./enums";
 import { trimPrefix } from "./string";
 
-const MODIFIER_KEYS: readonly Keyboard[] = [
+const MODIFIER_KEYS = [
   Keyboard.LEFT_SHIFT, // 340
   Keyboard.LEFT_CONTROL, // 341
   Keyboard.LEFT_ALT, // 342
@@ -17,25 +17,25 @@ const MODIFIER_KEYS: readonly Keyboard[] = [
   Keyboard.RIGHT_CONTROL, // 345
   Keyboard.RIGHT_ALT, // 346
   Keyboard.RIGHT_SUPER, // 347
-];
+] as const;
 
-const MOVEMENT_ACTIONS: readonly ButtonAction[] = [
+const MOVEMENT_ACTIONS = [
   ButtonAction.LEFT, // 0
   ButtonAction.RIGHT, // 1
   ButtonAction.UP, // 2
   ButtonAction.DOWN, // 3
-];
+] as const;
 
 export const MOVEMENT_ACTIONS_SET: ReadonlySet<ButtonAction> = new Set(
   MOVEMENT_ACTIONS,
 );
 
-const SHOOTING_ACTIONS: readonly ButtonAction[] = [
+const SHOOTING_ACTIONS = [
   ButtonAction.SHOOT_LEFT, // 4
   ButtonAction.SHOOT_RIGHT, // 5
   ButtonAction.SHOOT_UP, // 6
   ButtonAction.SHOOT_DOWN, // 7
-];
+] as const;
 
 export const SHOOTING_ACTIONS_SET: ReadonlySet<ButtonAction> = new Set(
   SHOOTING_ACTIONS,

package/src/functions/isaacAPIClass.ts

@@ -162,7 +162,7 @@ export function isTear(variable: unknown): variable is EntityTear {
 export function isaacAPIClassEquals(
   object1: unknown,
   object2: unknown,
-  keys: string[],
+  keys: string[] | readonly string[],
 ): boolean {
   const table1 = object1 as LuaMap<AnyNotNil, unknown>;
   const table2 = object2 as LuaMap<AnyNotNil, unknown>;

package/src/functions/kColor.ts

@@ -16,7 +16,7 @@ export type SerializedKColor = LuaMap<string, unknown> & {
 };
 
 const OBJECT_NAME = "KColor";
-const KEYS = ["Red", "Green", "Blue", "Alpha"];
+const KEYS = ["Red", "Green", "Blue", "Alpha"] as const;
 
 /** Helper function to copy a `KColor` Isaac API class. */
 export function copyKColor(kColor: KColor): KColor {

package/src/functions/levelGrid.ts

@@ -45,7 +45,7 @@ const UP = -LEVEL_GRID_ROW_WIDTH;
 const RIGHT = 1;
 const DOWN = LEVEL_GRID_ROW_WIDTH;
 
-const ADJACENT_ROOM_GRID_INDEX_DELTAS: readonly int[] = [LEFT, UP, RIGHT, DOWN];
+const ADJACENT_ROOM_GRID_INDEX_DELTAS = [LEFT, UP, RIGHT, DOWN] as const;
 
 /**
  * Helper function to get only the adjacent room grid indexes that exist (i.e. have room data).
@@ -300,10 +300,7 @@ export function getRoomShapeAdjacentExistingGridIndexes(
     getRoomShapeAdjacentGridIndexes(safeRoomGridIndex, roomShape),
   );
 
-  for (const [
-    doorSlot,
-    roomGridIndex,
-  ] of roomShapeAdjacentGridIndexes.entries()) {
+  for (const [doorSlot, roomGridIndex] of roomShapeAdjacentGridIndexes) {
     const roomData = getRoomData(roomGridIndex);
     if (roomData === undefined) {
       roomShapeAdjacentGridIndexes.delete(doorSlot);
@@ -369,10 +366,7 @@ export function getRoomShapeAdjacentNonExistingGridIndexes(
     getRoomShapeAdjacentGridIndexes(safeRoomGridIndex, roomShape),
   );
 
-  for (const [
-    doorSlot,
-    roomGridIndex,
-  ] of roomShapeAdjacentGridIndexes.entries()) {
+  for (const [doorSlot, roomGridIndex] of roomShapeAdjacentGridIndexes) {
     const roomData = getRoomData(roomGridIndex);
     if (roomData !== undefined) {
       roomShapeAdjacentGridIndexes.delete(doorSlot);

package/src/functions/map.ts

@@ -56,10 +56,10 @@ export function defaultMapSetHash<V>(
  * ]);
  * const searchText = "f";
  * const match = getMapPartialMatch(map, searchText); // match is now equal to ["foo", 123]
+ * ```
  *
  * @returns If a match was found, returns a tuple of the map key and value. If a match was not
- * found, returns undefined.
- * ```
+ *          found, returns undefined.
  */
 export function getMapPartialMatch<T>(
   searchText: string,

package/src/functions/merge.ts

@@ -219,7 +219,7 @@ function mergeSerializedTable(
         if (!isTable(oldValue)) {
           // The child table does not exist on the old table. However, we still need to copy over
           // the new table, because we need to handle data types like "Foo | null". Thus, set up a
-          // blank sub-table on the old table, and continue to recursively merge..
+          // blank sub-table on the old table, and continue to recursively merge.
           oldValue = new LuaMap();
           oldTable.set(key, oldValue);
         }

package/src/functions/minimap.ts

@@ -108,7 +108,7 @@ export function setDisplayFlags(
 ): void {
   const level = game.GetLevel();
 
-  for (const [roomGridIndex, displayFlags] of displayFlagsMap.entries()) {
+  for (const [roomGridIndex, displayFlags] of displayFlagsMap) {
     if (MinimapAPI === undefined) {
       // We pass false to the `updateVisibility` argument as a small optimization.
       setRoomDisplayFlags(roomGridIndex, displayFlags, false);

package/src/functions/rng.ts

@@ -18,7 +18,7 @@ export type SerializedRNG = LuaMap<string, unknown> & {
 const RECOMMENDED_SHIFT_IDX = 35;
 
 const OBJECT_NAME = "RNG";
-const KEYS = ["seed"];
+const KEYS = ["seed"] as const;
 
 /** Helper function to copy an `RNG` Isaac API class. */
 export function copyRNG(rng: RNG): RNG {

package/src/functions/table.ts

@@ -13,7 +13,7 @@ export function clearTable(luaMap: LuaMap<AnyNotNil, unknown>): void {
 /** Helper function to copy specific values from a userdata object (e.g. `Vector`) to a table. */
 export function copyUserdataValuesToTable(
   object: unknown,
-  keys: string[],
+  keys: string[] | readonly string[],
   luaMap: LuaMap<string, unknown>,
 ): void {
   if (!isUserdata(object)) {

package/src/functions/utils.ts

@@ -9,15 +9,14 @@ import { CONSOLE_COMMANDS_SET } from "../sets/consoleCommandsSet";
  * - For example, `eRange(1, 3)` will return `[1, 2]`.
  * - For example, `eRange(2)` will return `[0, 1]`.
  *
- * @param start The number to start at.
- * @param end Optional. The number to end at. If not specified, then the start will be 0 and the
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
  *            first argument will be the end.
  * @param increment Optional. The increment to use. Default is 1.
  */
 export function eRange(start: int, end?: int, increment = 1): int[] {
   if (end === undefined) {
-    end = start;
-    start = 0;
+    return eRange(0, start);
   }
 
   const array: int[] = [];
@@ -52,23 +51,18 @@ export function getTraversalDescription(
  * - For example, `iRange(1, 3)` will return `[1, 2, 3]`.
  * - For example, `iRange(2)` will return `[0, 1, 2]`.
  *
- * @param start The number to start at.
- * @param end Optional. The number to end at. If not specified, then the start will be 0 and the
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
  *            first argument will be the end.
  * @param increment Optional. The increment to use. Default is 1.
  */
 export function iRange(start: int, end?: int, increment = 1): int[] {
   if (end === undefined) {
-    end = start;
-    start = 0;
+    return iRange(0, start);
   }
 
-  const array: int[] = [];
-  for (let i = start; i <= end; i += increment) {
-    array.push(i);
-  }
-
-  return array;
+  const exclusiveEnd = end + 1;
+  return eRange(start, exclusiveEnd, increment);
 }
 
 /**
@@ -226,7 +220,7 @@ export function twoDimensionalSort<T>(array1: T[], array2: T[]): -1 | 0 | 1 {
  *
  * This function is only meant to be used with interfaces (i.e. types that will not exist at
  * run-time). If you are generating an object that will contain all of the keys of an enum, use the
- * `newObjectWithEnumKeys` helper function instead.
+ * `satisfies` operator with the `HasAllEnumValues` helper type instead.
  */
 export function validateInterfaceMatchesEnum<
   // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/src/functions/vector.ts

@@ -20,7 +20,7 @@ export type SerializedVector = LuaMap<string, unknown> & {
 };
 
 const OBJECT_NAME = "Vector";
-const KEYS = ["X", "Y"];
+const KEYS = ["X", "Y"] as const;
 
 /** Helper function to copy a `Vector` Isaac API class. */
 export function copyVector(vector: Vector): Vector {