isaacscript-common 15.6.1 → 15.6.2

package/dist/src/types/PublicInterface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PublicInterface.d.ts","sourceRoot":"","sources":["../../../src/types/PublicInterface.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,oBAAY,eAAe,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC"}
+{"version":3,"file":"PublicInterface.d.ts","sourceRoot":"","sources":["../../../src/types/PublicInterface.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC"}

package/dist/src/types/StartsWithLowercase.d.ts

@@ -1,3 +1,3 @@
 /** Helper type to ensure that the given string starts with an lowercase letter. */
-export declare type StartsWithLowercase<S> = S extends string ? Extract<S, Uncapitalize<S>> : never;
+export type StartsWithLowercase<S> = S extends string ? Extract<S, Uncapitalize<S>> : never;
 //# sourceMappingURL=StartsWithLowercase.d.ts.map

package/dist/src/types/StartsWithLowercase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StartsWithLowercase.d.ts","sourceRoot":"","sources":["../../../src/types/StartsWithLowercase.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,oBAAY,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACjD,OAAO,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GAC3B,KAAK,CAAC"}
+{"version":3,"file":"StartsWithLowercase.d.ts","sourceRoot":"","sources":["../../../src/types/StartsWithLowercase.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACjD,OAAO,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GAC3B,KAAK,CAAC"}

package/dist/src/types/StartsWithUppercase.d.ts

@@ -1,3 +1,3 @@
 /** Helper type to ensure that the given string starts with an uppercase letter. */
-export declare type StartsWithUppercase<S> = S extends string ? Extract<S, Capitalize<S>> : never;
+export type StartsWithUppercase<S> = S extends string ? Extract<S, Capitalize<S>> : never;
 //# sourceMappingURL=StartsWithUppercase.d.ts.map

package/dist/src/types/StartsWithUppercase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StartsWithUppercase.d.ts","sourceRoot":"","sources":["../../../src/types/StartsWithUppercase.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,oBAAY,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACjD,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,GACzB,KAAK,CAAC"}
+{"version":3,"file":"StartsWithUppercase.d.ts","sourceRoot":"","sources":["../../../src/types/StartsWithUppercase.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACjD,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,GACzB,KAAK,CAAC"}

package/dist/src/types/TSTLClass.d.ts

@@ -4,7 +4,7 @@
  *
  * This type is used by the save data manager to when copying, serializing, and deserializing.
  */
-export declare type TSTLClass = LuaMap<AnyNotNil, unknown> & {
+export type TSTLClass = LuaMap<AnyNotNil, unknown> & {
     readonly __tstlClassBrand: symbol;
 };
 //# sourceMappingURL=TSTLClass.d.ts.map

package/dist/src/types/TSTLClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TSTLClass.d.ts","sourceRoot":"","sources":["../../../src/types/TSTLClass.ts"],"names":[],"mappings":";AAAA;;;;GAIG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC"}
+{"version":3,"file":"TSTLClass.d.ts","sourceRoot":"","sources":["../../../src/types/TSTLClass.ts"],"names":[],"mappings":";AAAA;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC"}

package/dist/src/types/TupleToIntersection.d.ts

@@ -1,4 +1,4 @@
-export declare type TupleToIntersection<T extends unknown[]> = T extends [
+export type TupleToIntersection<T extends unknown[]> = T extends [
     infer F,
     ...infer R
 ] ? F & TupleToIntersection<R> : unknown;

package/dist/src/types/TupleToIntersection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TupleToIntersection.d.ts","sourceRoot":"","sources":["../../../src/types/TupleToIntersection.ts"],"names":[],"mappings":"AAAA,oBAAY,mBAAmB,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,SAAS;IAC/D,MAAM,CAAC;IACP,GAAG,MAAM,CAAC;CACX,GACG,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,GAC1B,OAAO,CAAC"}
+{"version":3,"file":"TupleToIntersection.d.ts","sourceRoot":"","sources":["../../../src/types/TupleToIntersection.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,SAAS;IAC/D,MAAM,CAAC;IACP,GAAG,MAAM,CAAC;CACX,GACG,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,GAC1B,OAAO,CAAC"}

package/dist/src/types/TupleToUnion.d.ts

@@ -1,3 +1,3 @@
 /** Helper type to convert a tuple to a union. */
-export declare type TupleToUnion<T extends unknown[]> = T[number];
+export type TupleToUnion<T extends unknown[]> = T[number];
 //# sourceMappingURL=TupleToUnion.d.ts.map

package/dist/src/types/TupleToUnion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TupleToUnion.d.ts","sourceRoot":"","sources":["../../../src/types/TupleToUnion.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,oBAAY,YAAY,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"TupleToUnion.d.ts","sourceRoot":"","sources":["../../../src/types/TupleToUnion.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/src/types/UnionToIntersection.d.ts

@@ -1,3 +1,3 @@
 /** Helper type to convert a union to an intersection. */
-export declare type UnionToIntersection<U> = (U extends U ? (u: U) => 0 : never) extends (i: infer I) => 0 ? Extract<I, U> : never;
+export type UnionToIntersection<U> = (U extends U ? (u: U) => 0 : never) extends (i: infer I) => 0 ? Extract<I, U> : never;
 //# sourceMappingURL=UnionToIntersection.d.ts.map

package/dist/src/types/UnionToIntersection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UnionToIntersection.d.ts","sourceRoot":"","sources":["../../../src/types/UnionToIntersection.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,oBAAY,mBAAmB,CAAC,CAAC,IAAI,CACnC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,CAClC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GACvB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GACb,KAAK,CAAC"}
+{"version":3,"file":"UnionToIntersection.d.ts","sourceRoot":"","sources":["../../../src/types/UnionToIntersection.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CACnC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,CAClC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GACvB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GACb,KAAK,CAAC"}

package/dist/src/types/UppercaseKeys.d.ts

@@ -1,4 +1,4 @@
 import { StartsWithUppercase } from "./StartsWithUppercase";
 /** Helper type to match all of the uppercase keys of an object. */
-export declare type UppercaseKeys<T> = StartsWithUppercase<keyof T>;
+export type UppercaseKeys<T> = StartsWithUppercase<keyof T>;
 //# sourceMappingURL=UppercaseKeys.d.ts.map

package/dist/src/types/UppercaseKeys.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UppercaseKeys.d.ts","sourceRoot":"","sources":["../../../src/types/UppercaseKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,mEAAmE;AACnE,oBAAY,aAAa,CAAC,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC"}
+{"version":3,"file":"UppercaseKeys.d.ts","sourceRoot":"","sources":["../../../src/types/UppercaseKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,mEAAmE;AACnE,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC"}

package/dist/src/types/WeightedArray.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
 /** An array where each element is paired with a number indicating that elements 'weight'. */
-export declare type WeightedArray<T> = Array<[T, float]>;
+export type WeightedArray<T> = Array<[T, float]>;
 //# sourceMappingURL=WeightedArray.d.ts.map

package/dist/src/types/WeightedArray.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WeightedArray.d.ts","sourceRoot":"","sources":["../../../src/types/WeightedArray.ts"],"names":[],"mappings":";AAAA,6FAA6F;AAC7F,oBAAY,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC"}
+{"version":3,"file":"WeightedArray.d.ts","sourceRoot":"","sources":["../../../src/types/WeightedArray.ts"],"names":[],"mappings":";AAAA,6FAA6F;AAC7F,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC"}

package/dist/src/types/Writable.d.ts

@@ -3,7 +3,7 @@
  *
  * This is the opposite of the built-in `Readonly` utility type.
  */
-export declare type Writeable<T> = {
+export type Writeable<T> = {
     -readonly [P in keyof T]: T[P];
 };
 //# sourceMappingURL=Writable.d.ts.map

package/dist/src/types/Writable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Writable.d.ts","sourceRoot":"","sources":["../../../src/types/Writable.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,SAAS,CAAC,CAAC,IAAI;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC"}
+{"version":3,"file":"Writable.d.ts","sourceRoot":"","sources":["../../../src/types/Writable.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC"}

package/dist/src/types/private/AllButFirst.d.ts

@@ -1,4 +1,4 @@
-export declare type AllButFirst<T extends unknown[]> = T extends [
+export type AllButFirst<T extends unknown[]> = T extends [
     unknown,
     ...infer Tail
 ] ? Tail : unknown[];

package/dist/src/types/private/AllButFirst.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AllButFirst.d.ts","sourceRoot":"","sources":["../../../../src/types/private/AllButFirst.ts"],"names":[],"mappings":"AAAA,oBAAY,WAAW,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,SAAS;IACvD,OAAO;IACP,GAAG,MAAM,IAAI;CACd,GACG,IAAI,GACJ,OAAO,EAAE,CAAC"}
+{"version":3,"file":"AllButFirst.d.ts","sourceRoot":"","sources":["../../../../src/types/private/AllButFirst.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,SAAS;IACvD,OAAO;IACP,GAAG,MAAM,IAAI;CACd,GACG,IAAI,GACJ,OAAO,EAAE,CAAC"}

package/dist/src/types/private/CallbackTuple.d.ts

@@ -6,7 +6,7 @@ import { AddCallbackParametersCustom } from "../../interfaces/private/AddCallbac
  * This is so that the respective callback functions can be added/removed on demand as subscribers
  * get added/removed.
  */
-export declare type CallbackTuple = {
+export type CallbackTuple = {
     [K in ModCallback]: [K, AddCallbackParameters[K]];
 }[ModCallback];
 /**
@@ -14,7 +14,7 @@ export declare type CallbackTuple = {
  * arguments). This is so that the respective callback functions can be added/removed on demand as
  * subscribers get added/removed.
  */
-export declare type CustomCallbackTuple = {
+export type CustomCallbackTuple = {
     [K in ModCallbackCustom]: [K, AddCallbackParametersCustom[K]];
 }[ModCallbackCustom];
 //# sourceMappingURL=CallbackTuple.d.ts.map

package/dist/src/types/private/CallbackTuple.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CallbackTuple.d.ts","sourceRoot":"","sources":["../../../../src/types/private/CallbackTuple.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,2BAA2B,EAAE,MAAM,sDAAsD,CAAC;AAEnG;;;;GAIG;AACH,oBAAY,aAAa,GAAG;KACzB,CAAC,IAAI,WAAW,GAAG,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;CAClD,CAAC,WAAW,CAAC,CAAC;AAEf;;;;GAIG;AACH,oBAAY,mBAAmB,GAAG;KAC/B,CAAC,IAAI,iBAAiB,GAAG,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC,iBAAiB,CAAC,CAAC"}
+{"version":3,"file":"CallbackTuple.d.ts","sourceRoot":"","sources":["../../../../src/types/private/CallbackTuple.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,2BAA2B,EAAE,MAAM,sDAAsD,CAAC;AAEnG;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG;KACzB,CAAC,IAAI,WAAW,GAAG,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;CAClD,CAAC,WAAW,CAAC,CAAC;AAEf;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,iBAAiB,GAAG,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC,CAAC,CAAC;CAC9D,CAAC,iBAAiB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "15.6.1",
+  "version": "15.6.2",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

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

@@ -6,9 +6,7 @@ import {
 import { game } from "../../../core/cachedClasses";
 import { Exported } from "../../../decorators";
 import { ISCFeature } from "../../../enums/ISCFeature";
-import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
 import { getEntityID } from "../../../functions/entities";
-import { getPickups } from "../../../functions/entitiesSpecific";
 import { getRoomListIndex } from "../../../functions/roomData";
 import { onAscent } from "../../../functions/stage";
 import { vectorEquals } from "../../../functions/vector";
@@ -60,40 +58,61 @@ export class PickupIndexCreation extends Feature {
       ], // 67
     ];
 
-    this.customCallbacksUsed = [
-      [ModCallbackCustom.POST_NEW_ROOM_REORDERED, [this.postNewRoomReordered]],
-    ];
-
     this.roomHistory = roomHistory;
   }
 
   // ModCallback.POST_PICKUP_INIT (34)
   private postPickupInit = (pickup: EntityPickup) => {
-    this.trySetPickupIndex(pickup);
+    this.setPickupIndex(pickup);
   };
 
-  private trySetPickupIndex(pickup: EntityPickup): void {
+  private setPickupIndex(pickup: EntityPickup): void {
     const ptrHash = GetPtrHash(pickup);
 
-    // In certain situations, pickups can be morphed, and this should not incur a new pickup
-    // counter. (For example, the collectible rotation with Tainted Isaac.)
+    // In certain situations, pickups can be morphed, which will trigger the `POST_PICKUP_INIT`
+    // callback but should not incur a new pickup counter. (For example, the collectible rotation
+    // with Tainted Isaac.) For these situations, we will already be tracking an index for this
+    // pointer hash.
     if (this.v.room.pickupIndexes.has(ptrHash)) {
       return;
     }
 
-    // If we are re-entering a room that previously had a pickup, then we don't need to make a new
-    // index, because we will re-use the existing one.
+    // First, handle the special case of re-entering a room with a previously tracked pickup. If we
+    // find a match in the level pickup data, we will use the pickup index from the match.
+    const pickupIndexFromLevelData =
+      this.getPickupIndexFromPreviousData(pickup);
     const room = game.GetRoom();
     const isFirstVisit = room.IsFirstVisit();
     const roomFrameCount = room.GetFrameCount();
-    if (!isFirstVisit && roomFrameCount <= 0) {
+    if (
+      pickupIndexFromLevelData !== undefined &&
+      !isFirstVisit &&
+      roomFrameCount <= 0
+    ) {
+      this.v.room.pickupIndexes.set(ptrHash, pickupIndexFromLevelData);
       return;
     }
 
+    // This is a brand new pickup that we have not previously seen on this run.
     this.v.run.pickupCounter++;
     this.v.room.pickupIndexes.set(ptrHash, this.v.run.pickupCounter);
   }
 
+  private getPickupIndexFromPreviousData(
+    pickup: EntityPickup,
+  ): PickupIndex | undefined {
+    const roomListIndex = getRoomListIndex();
+    const pickupDescriptions =
+      this.v.level.pickupData.getAndSetDefault(roomListIndex);
+
+    let pickupIndex = getStoredPickupIndex(pickup, pickupDescriptions);
+    if (pickupIndex === undefined) {
+      pickupIndex = this.getPostAscentPickupIndex(pickup);
+    }
+
+    return pickupIndex;
+  }
+
   // ModCallback.POST_ENTITY_REMOVE (67)
   // EntityType.PICKUP (5)
   private postEntityRemovePickup = (entity: Entity) => {
@@ -123,7 +142,7 @@ export class PickupIndexCreation extends Feature {
     pickupIndex: PickupIndex,
   ) {
     // The "latest" room description is really the previous room, because the `POST_NEW_ROOM`
-    // callback was not fired yet.
+    // callback has not fired yet.
     const previousRoomDescription = this.roomHistory.getLatestRoomDescription();
     if (previousRoomDescription === undefined) {
       return;
@@ -167,39 +186,9 @@ export class PickupIndexCreation extends Feature {
     }
   }
 
-  // ModCallbackCustom.POST_NEW_ROOM_REORDERED
-  private postNewRoomReordered = () => {
-    const room = game.GetRoom();
-    const isFirstVisit = room.IsFirstVisit();
-
-    if (isFirstVisit) {
-      return;
-    }
-
-    const roomListIndex = getRoomListIndex();
-    const pickupDescriptions =
-      this.v.level.pickupData.getAndSetDefault(roomListIndex);
-
-    for (const pickup of getPickups()) {
-      let pickupIndex = getStoredPickupIndex(pickup, pickupDescriptions);
-      if (pickupIndex === undefined) {
-        pickupIndex = this.getPostAscentPickupIndex(pickup);
-      }
-
-      if (pickupIndex === undefined) {
-        // At this point, if we do not already have an existing pickup index, we need to create a
-        // new one in order to cover the cases where mods spawn items in the `POST_NEW_ROOM`
-        // callback.
-        this.v.run.pickupCounter++;
-        pickupIndex = this.v.run.pickupCounter;
-      }
-
-      const ptrHash = GetPtrHash(pickup);
-      this.v.room.pickupIndexes.set(ptrHash, pickupIndex);
-    }
-  };
-
-  private getPostAscentPickupIndex(pickup: EntityPickup) {
+  private getPostAscentPickupIndex(
+    pickup: EntityPickup,
+  ): PickupIndex | undefined {
     // If we have not found the pickup index yet, we might be re-entering a post-Ascent Treasure
     // Room or Boss Room.
     if (!onAscent()) {
@@ -244,17 +233,18 @@ export class PickupIndexCreation extends Feature {
   public getPickupIndex(pickup: EntityPickup): PickupIndex {
     const ptrHash = GetPtrHash(pickup);
     const pickupIndexInitial = this.v.room.pickupIndexes.get(ptrHash);
-    if (pickupIndexInitial === undefined) {
-      this.trySetPickupIndex(pickup);
+    if (pickupIndexInitial !== undefined) {
+      return pickupIndexInitial;
     }
 
+    this.setPickupIndex(pickup);
     const pickupIndex = this.v.room.pickupIndexes.get(ptrHash);
-    if (pickupIndex === undefined) {
-      const entityID = getEntityID(pickup);
-      error(`Failed to generate a new pickup index for pickup: ${entityID}`);
+    if (pickupIndex !== undefined) {
+      return pickupIndex;
     }
 
-    return pickupIndex;
+    const entityID = getEntityID(pickup);
+    error(`Failed to generate a new pickup index for pickup: ${entityID}`);
   }
 }
 

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

@@ -120,8 +120,8 @@ export class RoomHistory extends Feature {
   /**
    * Helper function to detect if the game is in the state where the room index has changed to a new
    * room, but the entities from the previous room are currently in the process of despawning. (At
-   * this point, the `POST_NEW_ROOM` callback will not have fired yet, and there will not be an
-   * entry in the room history array for the current room.)
+   * this point, the `POST_NEW_ROOM` callback and the `POST_NEW_ROOM_EARLY` callback will not have
+   * fired yet, and there will not be an entry in the room history array for the current room.)
    *
    * This function is intended to be used in the `POST_ENTITY_REMOVE` callback to detect when an
    * entity is despawning.

package/src/classes/features/other/extraConsoleCommands/commands.ts

@@ -652,6 +652,8 @@ export function getChallenge(): void {
   const challenge = Isaac.GetChallenge();
   const challengeName = Challenge[challenge];
   const challengeDescription =
+    // Handle modded challenges.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     challengeName === undefined
       ? `${challenge} (custom)`
       : `Challenge.${challengeName} (${challenge})`;

package/src/functions/flag.ts

@@ -66,7 +66,7 @@ export function getFlagName<T extends BitFlag | BitFlag128>(
   flag: BitFlag,
   flagEnum: Record<string, T>,
 ): string | undefined {
-  for (const [key, value] of pairs(flagEnum)) {
+  for (const [key, value] of Object.entries(flagEnum)) {
     if (value === flag) {
       return key;
     }

package/src/functions/input.ts

@@ -45,12 +45,8 @@ export const SHOOTING_ACTIONS_SET: ReadonlySet<ButtonAction> = new Set(
  * Helper function to get the enum name for the specified `Controller` value. Note that this will
  * trim off the "BUTTON_" prefix.
  */
-export function controllerToString(controller: Controller): string | undefined {
+export function controllerToString(controller: Controller): string {
   const key = Controller[controller];
-  if (key === undefined) {
-    return undefined;
-  }
-
   return trimPrefix(key, "BUTTON_");
 }
 

package/src/functions/pills.ts

@@ -150,9 +150,9 @@ export function getPillEffectName(pillEffect: PillEffect): string {
 
 /**
  * Helper function to get a pill effect type from a PillEffect enum value. In this context, the type
- * is equal to positive, negative, or neutral. This is derived from the suffix of the the "class"
- * tag in the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the
- * "power" of the pill.
+ * is equal to positive, negative, or neutral. This is derived from the suffix of the "class" tag in
+ * the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the "power"
+ * of the pill.
  *
  * Due to limitations in the API, this function will not work properly for modded pill effects, and
  * will always return `DEFAULT_PILL_EFFECT_TYPE` in those cases.

package/src/functions/ui.ts

@@ -52,7 +52,7 @@ export function getHeartRowLength(player: EntityPlayer): int {
 /**
  * Helper function to get the width of the first player's hearts on the UI. This is useful for
  * drawing UI elements to the right of where the player's hearts are. Make sure to use this in
- * combination with the the `getHUDOffsetVector` helper function.
+ * combination with the `getHUDOffsetVector` helper function.
  */
 export function getHeartsUIWidth(): int {
   const level = game.GetLevel();

package/src/functions/vector.ts

@@ -117,6 +117,12 @@ export function serializeVector(vector: Vector): SerializedVector {
   return vectorTable as SerializedVector;
 }
 
+/**
+ * Helper function to compare two vectors for equality.
+ *
+ * This function is useful because vectors are not directly comparable. In other words, `Vector(1.2)
+ * === Vector(1.2)` will be equal to false.
+ */
 export function vectorEquals(vector1: Vector, vector2: Vector): boolean {
   return isaacAPIClassEquals(vector1, vector2, KEYS);
 }