isaacscript-common 72.1.1 → 72.2.0

package/src/functions/itemPool.ts

@@ -5,6 +5,7 @@ import type {
 import { ItemPoolType } from "isaac-typescript-definitions";
 import { ITEM_POOL_TYPE_VALUES } from "../arrays/cachedEnumValues";
 import { game } from "../core/cachedClasses";
+import { ITEM_POOL_TYPE_TO_COLLECTIBLE_TYPES_SET } from "../objects/itemPoolTypeToCollectibleTypesSet";
 import { arrayRemove, getRandomArrayElement } from "./array";
 
 const NORMAL_MODE_ONLY_ITEM_POOL_TYPES = [
@@ -41,6 +42,39 @@ const GREED_MODE_ITEM_POOL_TYPES: readonly ItemPoolType[] = arrayRemove(
   ...FAKE_ITEM_POOL_TYPES,
 );
 
+/**
+ * Helper function to get the collectibles that are in a particular item pool at the beginning of a
+ * vanilla run.
+ */
+export function getDefaultCollectibleTypesInItemPool(
+  itemPoolType: ItemPoolType,
+): Set<CollectibleType> {
+  return ITEM_POOL_TYPE_TO_COLLECTIBLE_TYPES_SET[itemPoolType];
+}
+
+/**
+ * Helper function to get the item pools that a particular collectible starts in at the beginning of
+ * a vanilla run.
+ *
+ * This function will automatically account for Greed Mode. In other words, it will not return the
+ * "normal" item pools when playing in Greed Mode.
+ */
+export function getDefaultItemPoolsForCollectibleType(
+  collectibleType: CollectibleType,
+): ItemPoolType[] {
+  const itemPoolTypes: ItemPoolType[] = [];
+
+  for (const itemPoolType of ITEM_POOL_TYPE_VALUES) {
+    const collectibleTypesSet =
+      ITEM_POOL_TYPE_TO_COLLECTIBLE_TYPES_SET[itemPoolType];
+    if (collectibleTypesSet.has(collectibleType)) {
+      itemPoolTypes.push(itemPoolType);
+    }
+  }
+
+  return itemPoolTypes;
+}
+
 /**
  * Helper function to get a random item pool. This is not as simple as getting a random value from
  * the `ItemPoolType` enum, since `ItemPoolType.SHELL_GAME` (7) is not a real item pool and the

package/src/functions/levelGrid.ts

@@ -432,6 +432,17 @@ export function getRoomShapeAdjacentNonExistingGridIndexes(
   return roomShapeAdjacentGridIndexes;
 }
 
+/**
+ * Helper function to determine if the current room grid index is inside of the normal 13x13 level
+ * grid.
+ *
+ * For example, Devil Rooms and the Mega Satan room are not considered to be inside the grid.
+ */
+export function inGrid(): boolean {
+  const roomGridIndex = getRoomGridIndex();
+  return isRoomInsideGrid(roomGridIndex);
+}
+
 /**
  * Helper function to detect if the current room was created by the Red Key item.
  *

package/src/maps/itemPoolTypeToItemPoolName.ts

@@ -0,0 +1,36 @@
+import { ItemPoolType } from "isaac-typescript-definitions";
+
+/** From "itempools.xml". */
+export const ITEM_POOL_TYPE_TO_ITEM_POOL_NAME = {
+  [ItemPoolType.TREASURE]: "treasure", // 0
+  [ItemPoolType.SHOP]: "shop", // 1
+  [ItemPoolType.BOSS]: "boss", // 2
+  [ItemPoolType.DEVIL]: "devil", // 3
+  [ItemPoolType.ANGEL]: "angel", // 4
+  [ItemPoolType.SECRET]: "secret", // 5
+  [ItemPoolType.LIBRARY]: "library", // 6
+  [ItemPoolType.SHELL_GAME]: "shellGame", // 7
+  [ItemPoolType.GOLDEN_CHEST]: "goldenChest", // 8
+  [ItemPoolType.RED_CHEST]: "redChest", // 9
+  [ItemPoolType.BEGGAR]: "beggar", // 10
+  [ItemPoolType.DEMON_BEGGAR]: "demonBeggar", // 11
+  [ItemPoolType.CURSE]: "curse", // 12
+  [ItemPoolType.KEY_MASTER]: "keyMaster", // 13
+  [ItemPoolType.BATTERY_BUM]: "batteryBum", // 14
+  [ItemPoolType.MOMS_CHEST]: "momsChest", // 15
+  [ItemPoolType.GREED_TREASURE]: "greedTreasure", // 16
+  [ItemPoolType.GREED_BOSS]: "greedBoss", // 17
+  [ItemPoolType.GREED_SHOP]: "greedShop", // 18
+  [ItemPoolType.GREED_DEVIL]: "greedDevil", // 19
+  [ItemPoolType.GREED_ANGEL]: "greedAngel", // 20
+  [ItemPoolType.GREED_CURSE]: "greedCurse", // 21
+  [ItemPoolType.GREED_SECRET]: "greedSecret", // 22
+  [ItemPoolType.CRANE_GAME]: "craneGame", // 23
+  [ItemPoolType.ULTRA_SECRET]: "ultraSecret", // 24
+  [ItemPoolType.BOMB_BUM]: "bombBum", // 25
+  [ItemPoolType.PLANETARIUM]: "planetarium", // 26
+  [ItemPoolType.OLD_CHEST]: "oldChest", // 27
+  [ItemPoolType.BABY_SHOP]: "babyShop", // 28
+  [ItemPoolType.WOODEN_CHEST]: "woodenChest", // 29
+  [ItemPoolType.ROTTEN_BEGGAR]: "rottenBeggar", // 30
+} as const satisfies Record<ItemPoolType, string>;

package/src/objects/itemPoolTypeToCollectibleTypesSet.ts

@@ -0,0 +1,54 @@
+import type {
+  CollectibleType,
+  ItemPoolType,
+} from "isaac-typescript-definitions";
+import { ITEM_POOL_TYPE_VALUES } from "../arrays/cachedEnumValues";
+import itemPoolsJSON from "../data/itempools.json";
+import { asCollectibleType } from "../functions/types";
+import { ITEM_POOL_TYPE_TO_ITEM_POOL_NAME } from "../maps/itemPoolTypeToItemPoolName";
+
+export const ITEM_POOL_TYPE_TO_COLLECTIBLE_TYPES_SET: Readonly<
+  Record<ItemPoolType, Set<CollectibleType>>
+> = (() => {
+  const itemPoolTypeToCollectibleTypes: Partial<
+    Record<ItemPoolType, Set<CollectibleType>>
+  > = {};
+
+  for (const itemPoolType of ITEM_POOL_TYPE_VALUES) {
+    const itemPoolJSON = getItemPoolJSON(itemPoolType);
+    if (itemPoolJSON === undefined) {
+      itemPoolTypeToCollectibleTypes[itemPoolType] = new Set();
+    } else {
+      const collectibleTypesSet = new Set<CollectibleType>();
+
+      for (const itemPoolJSONElement of itemPoolJSON.Item) {
+        const collectibleTypeNumber = tonumber(itemPoolJSONElement.$.Id);
+        if (collectibleTypeNumber === undefined) {
+          error(
+            `Failed to parse a collectible type in the "itempools.json" file: ${itemPoolJSONElement.$.Id}`,
+          );
+        }
+
+        const collectibleType = asCollectibleType(collectibleTypeNumber);
+        collectibleTypesSet.add(collectibleType);
+      }
+
+      itemPoolTypeToCollectibleTypes[itemPoolType] = collectibleTypesSet;
+    }
+  }
+
+  return itemPoolTypeToCollectibleTypes as Record<
+    ItemPoolType,
+    Set<CollectibleType>
+  >;
+})();
+
+function getItemPoolJSON(itemPoolType: ItemPoolType) {
+  const itemPoolName = ITEM_POOL_TYPE_TO_ITEM_POOL_NAME[itemPoolType];
+
+  const itemPoolsJSONArray = itemPoolsJSON.ItemPools.Pool;
+
+  return itemPoolsJSONArray.find(
+    (itemPoolJSON) => itemPoolJSON.$.Name === itemPoolName,
+  );
+}