isaacscript-common 21.6.6 → 21.8.0

package/src/arrays/cachedEnumValues.ts

@@ -10,6 +10,7 @@ import {
   GridEntityXMLType,
   ItemConfigCardType,
   ItemConfigTag,
+  ItemPoolType,
   Keyboard,
   PillColor,
   PlayerForm,
@@ -48,6 +49,9 @@ export const ITEM_CONFIG_TAG_VALUES: readonly ItemConfigTag[] =
 export const ITEM_CONFIG_CARD_TYPE_VALUES: readonly ItemConfigCardType[] =
   getEnumValues(ItemConfigCardType);
 
+export const ITEM_POOL_TYPE_VALUES: readonly ItemPoolType[] =
+  getEnumValues(ItemPoolType);
+
 export const KEYBOARD_VALUES: readonly Keyboard[] = getEnumValues(Keyboard);
 
 export const HEALTH_TYPE_VALUES: readonly HealthType[] =

package/src/callbackClasses.ts

@@ -58,6 +58,7 @@ export { PostNPCRenderFilter } from "./classes/callbacks/PostNPCRenderFilter";
 export { PostNPCStateChanged } from "./classes/callbacks/PostNPCStateChanged";
 export { PostNPCUpdateFilter } from "./classes/callbacks/PostNPCUpdateFilter";
 export { PostPEffectUpdateReordered } from "./classes/callbacks/PostPEffectUpdateReordered";
+export { PostPickupChanged } from "./classes/callbacks/PostPickupChanged";
 export { PostPickupCollect } from "./classes/callbacks/PostPickupCollect";
 export { PostPickupInitFilter } from "./classes/callbacks/PostPickupInitFilter";
 export { PostPickupInitFirst } from "./classes/callbacks/PostPickupInitFirst";

package/src/callbacks.ts

@@ -70,6 +70,7 @@ const MOD_CALLBACK_CUSTOM_TO_CLASS = {
   [ModCallbackCustom.POST_NPC_UPDATE_FILTER]: cc.PostNPCUpdateFilter,
   [ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED]:
     cc.PostPEffectUpdateReordered,
+  [ModCallbackCustom.POST_PICKUP_CHANGED]: cc.PostPickupChanged,
   [ModCallbackCustom.POST_PICKUP_COLLECT]: cc.PostPickupCollect,
   [ModCallbackCustom.POST_PICKUP_INIT_FILTER]: cc.PostPickupInitFilter,
   [ModCallbackCustom.POST_PICKUP_INIT_FIRST]: cc.PostPickupInitFirst,

package/src/classes/callbacks/PostPickupChanged.ts

@@ -0,0 +1,14 @@
+import { ISCFeature } from "../../enums/ISCFeature";
+import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
+import { shouldFirePickup } from "../../shouldFire";
+import { CustomCallback } from "../private/CustomCallback";
+
+export class PostPickupChanged extends CustomCallback<ModCallbackCustom.POST_PICKUP_CHANGED> {
+  constructor() {
+    super();
+
+    this.featuresUsed = [ISCFeature.PICKUP_CHANGE_DETECTION];
+  }
+
+  protected override shouldFire = shouldFirePickup;
+}

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

@@ -0,0 +1,61 @@
+import { ModCallback, PickupVariant } from "isaac-typescript-definitions";
+import { ISCFeature } from "../../../enums/ISCFeature";
+import { PickupIndex } from "../../../types/PickupIndex";
+import { PostPickupChanged } from "../../callbacks/PostPickupChanged";
+import { Feature } from "../../private/Feature";
+import { PickupIndexCreation } from "../other/PickupIndexCreation";
+
+export class PickupChangeDetection extends Feature {
+  public override v = {
+    room: {
+      pickupVariants: new Map<PickupIndex, PickupVariant>(),
+      pickupSubTypes: new Map<PickupIndex, int>(),
+    },
+  };
+
+  private postPickupChanged: PostPickupChanged;
+  private pickupIndexCreation: PickupIndexCreation;
+
+  constructor(
+    postPickupChanged: PostPickupChanged,
+    pickupIndexCreation: PickupIndexCreation,
+  ) {
+    super();
+
+    this.featuresUsed = [ISCFeature.PICKUP_INDEX_CREATION];
+
+    this.callbacksUsed = [
+      // 35
+      [ModCallback.POST_PICKUP_UPDATE, this.postPickupUpdate],
+    ];
+
+    this.postPickupChanged = postPickupChanged;
+    this.pickupIndexCreation = pickupIndexCreation;
+  }
+
+  // ModCallback.POST_PICKUP_UPDATE (35)
+  private postPickupUpdate = (pickup: EntityPickup) => {
+    const pickupIndex = this.pickupIndexCreation.getPickupIndex(pickup);
+
+    const oldVariant = this.v.room.pickupVariants.get(pickupIndex);
+    this.v.room.pickupVariants.set(pickupIndex, pickup.Variant);
+
+    const oldSubType = this.v.room.pickupSubTypes.get(pickupIndex);
+    this.v.room.pickupSubTypes.set(pickupIndex, pickup.SubType);
+
+    // If this is the first update frame for the pickup, it cannot have changed.
+    if (oldVariant === undefined || oldSubType === undefined) {
+      return;
+    }
+
+    if (oldVariant !== pickup.Variant || oldSubType !== pickup.SubType) {
+      this.postPickupChanged.fire(
+        pickup,
+        oldVariant,
+        oldSubType,
+        pickup.Variant,
+        pickup.SubType,
+      );
+    }
+  };
+}

package/src/enums/ISCFeature.ts

@@ -8,6 +8,7 @@ export enum ISCFeature {
   GRID_ENTITY_UPDATE_DETECTION,
   GAME_REORDERED_CALLBACKS,
   ITEM_PICKUP_DETECTION,
+  PICKUP_CHANGE_DETECTION,
   PLAYER_COLLECTIBLE_DETECTION,
   PLAYER_REORDERED_CALLBACKS,
   SLOT_DESTROYED_DETECTION,

package/src/enums/ModCallbackCustom.ts

@@ -1058,6 +1058,28 @@ export enum ModCallbackCustom {
    */
   POST_PEFFECT_UPDATE_REORDERED,
 
+  /**
+   * Fires from the `POST_PICKUP_UPDATE` callback when a pickup has a different variant or sub-type
+   * than what it was on the previous frame.
+   *
+   * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+   * - You can provide an optional third argument that will make the callback only fire if the new
+   *   pickup matches the `PickupVariant` provided.
+   * - You can provide an optional third argument that will make the callback only fire if the new
+   *   pickup matches the sub-type provided.
+   *
+   * ```ts
+   * function postPickupChanged(
+   *   pickup: EntityPickup,
+   *   oldVariant: PickupVariant,
+   *   oldSubType: int,
+   *   newVariant: PickupVariant,
+   *   newSubType: int,
+   * ): void {}
+   * ```
+   */
+  POST_PICKUP_CHANGED,
+
   /**
    * Fires on the first `POST_RENDER` frame that a pickup plays the "Collect" animation.
    *

package/src/features.ts

@@ -8,6 +8,7 @@ import { GridEntityCollisionDetection } from "./classes/features/callbackLogic/G
 import { GridEntityRenderDetection } from "./classes/features/callbackLogic/GridEntityRenderDetection";
 import { GridEntityUpdateDetection } from "./classes/features/callbackLogic/GridEntityUpdateDetection";
 import { ItemPickupDetection } from "./classes/features/callbackLogic/ItemPickupDetection";
+import { PickupChangeDetection } from "./classes/features/callbackLogic/PickupChangeDetection";
 import { PlayerCollectibleDetection } from "./classes/features/callbackLogic/PlayerCollectibleDetection";
 import { PlayerReorderedCallbacks } from "./classes/features/callbackLogic/PlayerReorderedCallbacks";
 import { SlotDestroyedDetection } from "./classes/features/callbackLogic/SlotDestroyedDetection";
@@ -69,6 +70,7 @@ export interface ISCFeatureToClass {
   [ISCFeature.GRID_ENTITY_UPDATE_DETECTION]: GridEntityUpdateDetection;
   [ISCFeature.GAME_REORDERED_CALLBACKS]: GameReorderedCallbacks;
   [ISCFeature.ITEM_PICKUP_DETECTION]: ItemPickupDetection;
+  [ISCFeature.PICKUP_CHANGE_DETECTION]: PickupChangeDetection;
   [ISCFeature.PLAYER_COLLECTIBLE_DETECTION]: PlayerCollectibleDetection;
   [ISCFeature.PLAYER_REORDERED_CALLBACKS]: PlayerReorderedCallbacks;
   [ISCFeature.SLOT_DESTROYED_DETECTION]: SlotDestroyedDetection;
@@ -213,6 +215,10 @@ export function getFeatures(
       callbacks[ModCallbackCustom.POST_ITEM_PICKUP],
       callbacks[ModCallbackCustom.PRE_ITEM_PICKUP],
     ),
+    [ISCFeature.PICKUP_CHANGE_DETECTION]: new PickupChangeDetection(
+      callbacks[ModCallbackCustom.POST_PICKUP_CHANGED],
+      pickupIndexCreation,
+    ),
     [ISCFeature.PLAYER_COLLECTIBLE_DETECTION]: new PlayerCollectibleDetection(
       callbacks[ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED],
       callbacks[ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED],

package/src/functions/itemPool.ts

@@ -0,0 +1,50 @@
+import { ItemPoolType } from "isaac-typescript-definitions";
+import { ITEM_POOL_TYPE_VALUES } from "../arrays/cachedEnumValues";
+import { arrayRemove, getRandomArrayElement } from "./array";
+import { isGreedMode } from "./run";
+
+const NORMAL_MODE_ONLY_ITEM_POOL_TYPES = [
+  ItemPoolType.TREASURE, // 0
+  ItemPoolType.BOSS, // 2
+  ItemPoolType.SHOP, // 1
+  ItemPoolType.DEVIL, // 3
+  ItemPoolType.ANGEL, // 4
+  ItemPoolType.CURSE, // 12
+  ItemPoolType.SECRET, // 5
+] as const;
+
+const GREED_MODE_ONLY_ITEM_POOL_TYPES = [
+  ItemPoolType.GREED_TREASURE, // 16
+  ItemPoolType.GREED_BOSS, // 17
+  ItemPoolType.GREED_SHOP, // 18
+  ItemPoolType.GREED_DEVIL, // 19
+  ItemPoolType.GREED_ANGEL, // 20
+  ItemPoolType.GREED_CURSE, // 21
+  ItemPoolType.GREED_SECRET, // 22
+] as const;
+
+const FAKE_ITEM_POOL_TYPES = [ItemPoolType.SHELL_GAME] as const;
+
+const NORMAL_MODE_ITEM_POOL_TYPES: readonly ItemPoolType[] = arrayRemove(
+  ITEM_POOL_TYPE_VALUES,
+  ...GREED_MODE_ONLY_ITEM_POOL_TYPES,
+  ...FAKE_ITEM_POOL_TYPES,
+);
+
+const GREED_MODE_ITEM_POOL_TYPES: readonly ItemPoolType[] = arrayRemove(
+  ITEM_POOL_TYPE_VALUES,
+  ...NORMAL_MODE_ONLY_ITEM_POOL_TYPES,
+  ...FAKE_ITEM_POOL_TYPES,
+);
+
+/**
+ * Helper function to get a random item pool. This is as simple as getting a random value from the
+ * `ItemPoolType` enum, since `ItemPoolType.SHELL_GAME` (7) is not a real item pool and the Greed
+ * Mode item pools should be excluded if not playing in Greed Mode.
+ */
+export function getRandomItemPool(): ItemPoolType {
+  const itemPoolTypes = isGreedMode()
+    ? GREED_MODE_ITEM_POOL_TYPES
+    : NORMAL_MODE_ITEM_POOL_TYPES;
+  return getRandomArrayElement(itemPoolTypes);
+}

package/src/index.ts

@@ -61,6 +61,7 @@ export * from "./functions/hex";
 export * from "./functions/initArray";
 export * from "./functions/input";
 export * from "./functions/isaacAPIClass";
+export * from "./functions/itemPool";
 export * from "./functions/jsonHelpers";
 export * from "./functions/jsonRoom";
 export * from "./functions/kColor";

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -439,6 +439,18 @@ export interface AddCallbackParametersCustom {
     character?: PlayerType,
   ];
 
+  [ModCallbackCustom.POST_PICKUP_CHANGED]: [
+    callback: (
+      pickup: EntityPickup,
+      oldVariant: PickupVariant,
+      oldSubType: int,
+      newVariant: PickupVariant,
+      newSubType: int,
+    ) => void,
+    pickupVariant?: PickupVariant,
+    subType?: int,
+  ];
+
   [ModCallbackCustom.POST_PICKUP_COLLECT]: [
     callback: (pickup: EntityPickup, player: EntityPlayer) => void,
     pickupVariant?: PickupVariant,

package/src/shouldFire.ts

@@ -267,7 +267,14 @@ export function shouldFirePickup(
     | [pickup: EntityPickup]
     | [pickup: EntityPickup, renderOffset: Vector]
     | [pickup: EntityPickup, player: EntityPlayer]
-    | [pickup: EntityPickup, previousState: int, currentState: int],
+    | [pickup: EntityPickup, previousState: int, currentState: int]
+    | [
+        pickup: EntityPickup,
+        oldVariant: PickupVariant,
+        oldSubType: int,
+        newVariant: PickupVariant,
+        newSubType: int,
+      ],
   optionalArgs: [pickupVariant?: PickupVariant, subType?: int],
 ): boolean {
   const [pickup] = fireArgs;