isaacscript-common 7.18.0 → 8.0.0

package/src/functions/collectibleSet.ts

@@ -2,9 +2,9 @@ import { CollectibleType } from "isaac-typescript-definitions";
 import { itemConfig } from "../core/cachedClasses";
 import {
   FIRST_COLLECTIBLE_TYPE,
-  LAST_COLLECTIBLE_TYPE,
   LAST_VANILLA_COLLECTIBLE_TYPE,
 } from "../core/constantsFirstLast";
+import { getLastCollectibleType } from "../features/firstLast";
 import { irange } from "./utils";
 
 const ALL_COLLECTIBLES_ARRAY: CollectibleType[] = [];
@@ -15,14 +15,15 @@ const ALL_COLLECTIBLES_SET = new Set<CollectibleType>();
 const VANILLA_COLLECTIBLES_SET = new Set<CollectibleType>();
 const MODDED_COLLECTIBLES_SET = new Set<CollectibleType>();
 
-function initCollectibleArraysAndSets() {
+function lazyInitCollectibleArraysAndSets() {
   if (ALL_COLLECTIBLES_ARRAY.length !== 0) {
     return;
   }
 
+  const lastCollectibleType = getLastCollectibleType();
   const collectibleTypeRange = irange(
     FIRST_COLLECTIBLE_TYPE,
-    LAST_COLLECTIBLE_TYPE,
+    lastCollectibleType,
   ) as CollectibleType[];
   for (const collectibleType of collectibleTypeRange) {
     const itemConfigItem = itemConfig.GetCollectible(collectibleType);
@@ -60,11 +61,12 @@ function initCollectibleArraysAndSets() {
  *
  * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
  * then use the `getCollectibleSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getCollectibleArray(): readonly CollectibleType[] {
-  // Lazy initialize the arrays/sets.
-  initCollectibleArraysAndSets();
-
+  lazyInitCollectibleArraysAndSets();
   return ALL_COLLECTIBLES_ARRAY;
 }
 
@@ -73,11 +75,12 @@ export function getCollectibleArray(): readonly CollectibleType[] {
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
  * then use the `getCollectibleArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getCollectibleSet(): ReadonlySet<CollectibleType> {
-  // Lazy initialize the arrays/sets.
-  initCollectibleArraysAndSets();
-
+  lazyInitCollectibleArraysAndSets();
   return ALL_COLLECTIBLES_SET;
 }
 
@@ -86,11 +89,12 @@ export function getCollectibleSet(): ReadonlySet<CollectibleType> {
  *
  * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
  * then use the `getModdedCollectibleSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getModdedCollectibleArray(): readonly CollectibleType[] {
-  // Lazy initialize the arrays/sets.
-  initCollectibleArraysAndSets();
-
+  lazyInitCollectibleArraysAndSets();
   return MODDED_COLLECTIBLES_ARRAY;
 }
 
@@ -99,11 +103,12 @@ export function getModdedCollectibleArray(): readonly CollectibleType[] {
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
  * then use the `getModdedCollectibleArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getModdedCollectibleSet(): ReadonlySet<CollectibleType> {
-  // Lazy initialize the arrays/sets.
-  initCollectibleArraysAndSets();
-
+  lazyInitCollectibleArraysAndSets();
   return MODDED_COLLECTIBLES_SET;
 }
 
@@ -112,11 +117,12 @@ export function getModdedCollectibleSet(): ReadonlySet<CollectibleType> {
  *
  * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
  * then use the `getVanillaCollectibleSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getVanillaCollectibleArray(): readonly CollectibleType[] {
-  // Lazy initialize the arrays/sets.
-  initCollectibleArraysAndSets();
-
+  lazyInitCollectibleArraysAndSets();
   return VANILLA_COLLECTIBLES_ARRAY;
 }
 
@@ -125,10 +131,11 @@ export function getVanillaCollectibleArray(): readonly CollectibleType[] {
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
  * then use the `getVanillaCollectibleArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getVanillaCollectibleSet(): ReadonlySet<CollectibleType> {
-  // Lazy initialize the arrays/sets.
-  initCollectibleArraysAndSets();
-
+  lazyInitCollectibleArraysAndSets();
   return VANILLA_COLLECTIBLES_SET;
 }

package/src/functions/collectibles.ts

@@ -13,8 +13,6 @@ import { game, itemConfig } from "../core/cachedClasses";
 import { BLIND_ITEM_PNG_PATH, DEFAULT_ITEM_POOL_TYPE } from "../core/constants";
 import {
   FIRST_COLLECTIBLE_TYPE,
-  FIRST_MODDED_COLLECTIBLE_TYPE,
-  LAST_COLLECTIBLE_TYPE,
   LAST_VANILLA_COLLECTIBLE_TYPE,
 } from "../core/constantsFirstLast";
 import {
@@ -372,26 +370,6 @@ export function getCollectibleTags(
   return itemConfigItem === undefined ? ItemConfigTagZero : itemConfigItem.Tags;
 }
 
-/**
- * Helper function to get an array that represents the all modded collectible types.
- *
- * This function is only useful when building collectible type objects. For most purposes, you
- * should use the `getModdedCollectibleSet` helper function instead.
- *
- * Returns an empty array if there are no modded collectible types.
- *
- * (This function is named differently from the `getVanillaCollectibleTypeRange` function because
- * all modded collectible types are contiguous. Thus, each value represents a real
- * `CollectibleType`.)
- */
-export function getModdedCollectibleTypes(): CollectibleType[] {
-  if (LAST_VANILLA_COLLECTIBLE_TYPE === LAST_COLLECTIBLE_TYPE) {
-    return [];
-  }
-
-  return irange(FIRST_MODDED_COLLECTIBLE_TYPE, LAST_COLLECTIBLE_TYPE);
-}
-
 /**
  * Helper function to get an array that represents the range from the first collectible type to the
  * last vanilla collectible type. This will include integers that do not represent any valid

package/src/functions/flying.ts

@@ -5,7 +5,7 @@ import {
   PlayerType,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { getCollectiblesForCacheFlag } from "./cacheFlag";
+import { getCollectiblesForCacheFlag } from "./collectibleCacheFlag";
 import { copySet, deleteSetsFromSet } from "./set";
 
 const FLYING_CHARACTERS: ReadonlySet<PlayerType> = new Set([

package/src/functions/pills.ts

@@ -7,12 +7,10 @@ import {
 import { itemConfig } from "../core/cachedClasses";
 import {
   FIRST_HORSE_PILL_COLOR,
-  FIRST_MODDED_PILL_EFFECT,
   FIRST_PILL_COLOR,
   FIRST_PILL_EFFECT,
   LAST_HORSE_PILL_COLOR,
   LAST_NORMAL_PILL_COLOR,
-  LAST_PILL_EFFECT,
   LAST_VANILLA_PILL_EFFECT,
 } from "../core/constantsFirstLast";
 import { FALSE_PHD_PILL_CONVERSIONS } from "../maps/falsePHDPillConversions";
@@ -52,13 +50,6 @@ export function getAllPillColors(): PillColor[] {
   return pillColors;
 }
 
-/**
- * Helper function to get an array with every valid pill effect. This includes modded pill effects.
- */
-export function getAllPillEffects(): PillEffect[] {
-  return irange(FIRST_PILL_EFFECT, LAST_PILL_EFFECT);
-}
-
 /**
  * Helper function to get the associated pill effect after False PHD is acquired. If a pill effect
  * is not altered by False PHD, then the same pill effect will be returned.
@@ -83,19 +74,6 @@ export function getHorsePillColors(): PillColor[] {
   return irange(FIRST_HORSE_PILL_COLOR, LAST_HORSE_PILL_COLOR);
 }
 
-/**
- * Helper function to get an array with every modded pill effect.
- *
- * Returns an empty array if there are no modded pill effects.
- */
-export function getModdedPillEffects(): PillEffect[] {
-  if (LAST_VANILLA_PILL_EFFECT === LAST_PILL_EFFECT) {
-    return [];
-  }
-
-  return irange(FIRST_MODDED_PILL_EFFECT, LAST_PILL_EFFECT);
-}
-
 /**
  * Helper function to get the corresponding normal pill color from a horse pill color.
  *

package/src/functions/random.ts

@@ -71,6 +71,9 @@ export function getRandomInt(
 ): int {
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
+  min = Math.ceil(min);
+  max = Math.floor(max);
+
   if (min > max) {
     const oldMin = min;
     const oldMax = max;

package/src/functions/stats.ts

@@ -0,0 +1,12 @@
+import { CacheFlag } from "isaac-typescript-definitions";
+import { DEFAULT_PLAYER_STAT_MAP } from "../maps/defaultPlayerStatMap";
+
+/**
+ * Returns the starting stat that Isaac (the default character) starts with. For example, if you
+ * pass this function `CacheFlag.DAMAGE`, it will return 3.5.
+ *
+ * Note that the default fire delay is represented in the tear stat, not the `MaxFireDelay` value.
+ */
+export function getDefaultPlayerStat(cacheFlag: CacheFlag): number | undefined {
+  return DEFAULT_PLAYER_STAT_MAP.get(cacheFlag);
+}

package/src/functions/trinketCacheFlag.ts

@@ -1,11 +1,17 @@
 import { CacheFlag, TrinketType } from "isaac-typescript-definitions";
+import { itemConfig } from "../core/cachedClasses";
+import { getTrinketTypes } from "../features/firstLast";
 import { getEnumValues } from "./enums";
+import { hasFlag } from "./flag";
 import { copySet } from "./set";
-import { getTrinketTypes, trinketHasCacheFlag } from "./trinkets";
 
 const CACHE_FLAG_TO_TRINKETS_MAP = new Map<CacheFlag, Set<TrinketType>>();
 
-function initCacheFlagMap() {
+function lazyInitCacheFlagMap() {
+  if (CACHE_FLAG_TO_TRINKETS_MAP.size > 0) {
+    return;
+  }
+
   for (const cacheFlag of getEnumValues(CacheFlag)) {
     const trinketsSet = new Set<TrinketType>();
 
@@ -21,7 +27,10 @@ function initCacheFlagMap() {
 
 /**
  * Returns a map containing every trinket type that the player has that matches the provided
- * CacheFlag. The values of the map correspond to the multiplier for that trinket.
+ * `CacheFlag`. The values of the map correspond to the multiplier for that trinket.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getPlayerTrinketsForCacheFlag(
   player: EntityPlayer,
@@ -42,14 +51,14 @@ export function getPlayerTrinketsForCacheFlag(
 
 /**
  * Returns a set containing every trinket type with the given cache flag, including modded trinkets.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getTrinketsForCacheFlag(
   cacheFlag: CacheFlag,
 ): Set<TrinketType> {
-  // Lazy initialize the map.
-  if (CACHE_FLAG_TO_TRINKETS_MAP.size === 0) {
-    initCacheFlagMap();
-  }
+  lazyInitCacheFlagMap();
 
   const trinketsSet = CACHE_FLAG_TO_TRINKETS_MAP.get(cacheFlag);
   if (trinketsSet === undefined) {
@@ -58,3 +67,16 @@ export function getTrinketsForCacheFlag(
 
   return copySet(trinketsSet);
 }
+
+/** Helper function to check in the item config if a given trinket has a given cache flag. */
+export function trinketHasCacheFlag(
+  trinketType: TrinketType,
+  cacheFlag: CacheFlag,
+): boolean {
+  const itemConfigItem = itemConfig.GetTrinket(trinketType);
+  if (itemConfigItem === undefined) {
+    return false;
+  }
+
+  return hasFlag(itemConfigItem.CacheFlags, cacheFlag);
+}

package/src/functions/trinketSet.ts

@@ -2,9 +2,9 @@ import { TrinketType } from "isaac-typescript-definitions";
 import { itemConfig } from "../core/cachedClasses";
 import {
   FIRST_TRINKET_TYPE,
-  LAST_TRINKET_TYPE,
   LAST_VANILLA_TRINKET_TYPE,
 } from "../core/constantsFirstLast";
+import { getLastTrinketType } from "../features/firstLast";
 import { irange } from "./utils";
 
 const ALL_TRINKETS_ARRAY: TrinketType[] = [];
@@ -15,14 +15,15 @@ const ALL_TRINKETS_SET = new Set<TrinketType>();
 const VANILLA_TRINKETS_SET = new Set<TrinketType>();
 const MODDED_TRINKETS_SET = new Set<TrinketType>();
 
-function initTrinketArraysAndSets() {
+function lazyInitTrinketArraysAndSets() {
   if (ALL_TRINKETS_ARRAY.length !== 0) {
     return;
   }
 
+  const lastTrinketType = getLastTrinketType();
   const trinketTypeRange = irange(
     FIRST_TRINKET_TYPE,
-    LAST_TRINKET_TYPE,
+    lastTrinketType,
   ) as TrinketType[];
   for (const trinketType of trinketTypeRange) {
     const itemConfigItem = itemConfig.GetTrinket(trinketType);
@@ -59,11 +60,12 @@ function initTrinketArraysAndSets() {
  *
  * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
  * use the `getTrinketSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getModdedTrinketArray(): readonly TrinketType[] {
-  // Lazy initialize the arrays/sets.
-  initTrinketArraysAndSets();
-
+  lazyInitTrinketArraysAndSets();
   return MODDED_TRINKETS_ARRAY;
 }
 
@@ -72,11 +74,12 @@ export function getModdedTrinketArray(): readonly TrinketType[] {
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
  * use the `getTrinketArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getModdedTrinketSet(): ReadonlySet<TrinketType> {
-  // Lazy initialize the arrays/sets.
-  initTrinketArraysAndSets();
-
+  lazyInitTrinketArraysAndSets();
   return MODDED_TRINKETS_SET;
 }
 
@@ -85,11 +88,12 @@ export function getModdedTrinketSet(): ReadonlySet<TrinketType> {
  *
  * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
  * use the `getModdedTrinketSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getTrinketArray(): readonly TrinketType[] {
-  // Lazy initialize the arrays/sets.
-  initTrinketArraysAndSets();
-
+  lazyInitTrinketArraysAndSets();
   return ALL_TRINKETS_ARRAY;
 }
 
@@ -98,11 +102,12 @@ export function getTrinketArray(): readonly TrinketType[] {
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
  * use the `getModdedTrinketArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getTrinketSet(): ReadonlySet<TrinketType> {
-  // Lazy initialize the arrays/sets.
-  initTrinketArraysAndSets();
-
+  lazyInitTrinketArraysAndSets();
   return ALL_TRINKETS_SET;
 }
 
@@ -111,11 +116,12 @@ export function getTrinketSet(): ReadonlySet<TrinketType> {
  *
  * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
  * use the `getVanillaTrinketSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getVanillaTrinketArray(): readonly TrinketType[] {
-  // Lazy initialize the arrays/sets.
-  initTrinketArraysAndSets();
-
+  lazyInitTrinketArraysAndSets();
   return VANILLA_TRINKETS_ARRAY;
 }
 
@@ -124,10 +130,11 @@ export function getVanillaTrinketArray(): readonly TrinketType[] {
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
  * use the `getVanillaTrinketArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getVanillaTrinketSet(): ReadonlySet<TrinketType> {
-  // Lazy initialize the arrays/sets.
-  initTrinketArraysAndSets();
-
+  lazyInitTrinketArraysAndSets();
   return VANILLA_TRINKETS_SET;
 }

package/src/functions/trinkets.ts

@@ -1,14 +1,11 @@
 import {
-  CacheFlag,
   PlayerType,
   TrinketSlot,
   TrinketType,
 } from "isaac-typescript-definitions";
 import { itemConfig } from "../core/cachedClasses";
 import {
-  FIRST_MODDED_TRINKET_TYPE,
   FIRST_TRINKET_TYPE,
-  LAST_TRINKET_TYPE,
   LAST_VANILLA_TRINKET_TYPE,
 } from "../core/constantsFirstLast";
 import {
@@ -17,7 +14,6 @@ import {
 } from "../maps/trinketDescriptionMap";
 import { DEFAULT_TRINKET_NAME, TRINKET_NAME_MAP } from "../maps/trinketNameMap";
 import { getEntityID } from "./entities";
-import { hasFlag } from "./flag";
 import { isTrinket } from "./pickupVariants";
 import { isCharacter } from "./players";
 import { clearSprite } from "./sprites";
@@ -45,19 +41,6 @@ export function getGoldenTrinketType(trinketType: TrinketType): TrinketType {
   return asNumber(trinketType) + GOLDEN_TRINKET_ADJUSTMENT;
 }
 
-/**
- * Helper function to get an array that represents every modded trinket type.
- *
- * Returns an empty array if there are no modded trinket types.
- */
-export function getModdedTrinketTypes(): TrinketType[] {
-  if (LAST_VANILLA_TRINKET_TYPE === LAST_TRINKET_TYPE) {
-    return [];
-  }
-
-  return irange(FIRST_MODDED_TRINKET_TYPE, LAST_TRINKET_TYPE);
-}
-
 /**
  * Returns the slot number corresponding to where a trinket can be safely inserted.
  *
@@ -139,11 +122,6 @@ export function getTrinketName(trinketType: TrinketType): string {
   return DEFAULT_TRINKET_NAME;
 }
 
-/** Helper function to get an array that contains every trinket type. */
-export function getTrinketTypes(): TrinketType[] {
-  return irange(FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE);
-}
-
 /** Helper function to get an array that represents every vanilla trinket type. */
 export function getVanillaTrinketTypes(): TrinketType[] {
   return irange(FIRST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE);
@@ -200,15 +178,3 @@ export function setTrinketSprite(
     sprite.LoadGraphics();
   }
 }
-
-export function trinketHasCacheFlag(
-  trinketType: TrinketType,
-  cacheFlag: CacheFlag,
-): boolean {
-  const itemConfigItem = itemConfig.GetTrinket(trinketType);
-  if (itemConfigItem === undefined) {
-    return false;
-  }
-
-  return hasFlag(itemConfigItem.CacheFlags, cacheFlag);
-}

package/src/index.ts

@@ -29,6 +29,7 @@ export * from "./features/disableInputs";
 export * from "./features/extraConsoleCommands/exports";
 export * from "./features/fadeInRemover";
 export * from "./features/fastReset";
+export * from "./features/firstLast";
 export * from "./features/forgottenSwitch";
 export * from "./features/pause";
 export * from "./features/persistentEntities";
@@ -52,12 +53,12 @@ export * from "./functions/bitSet128";
 export * from "./functions/bitwise";
 export * from "./functions/bombs";
 export * from "./functions/bosses";
-export * from "./functions/cacheFlag";
 export * from "./functions/cards";
 export * from "./functions/challenges";
 export * from "./functions/characters";
 export * from "./functions/charge";
 export * from "./functions/chargeBar";
+export * from "./functions/collectibleCacheFlag";
 export * from "./functions/collectibles";
 export * from "./functions/collectibleSet";
 export * from "./functions/collectibleTag";

package/dist/functions/cacheFlag.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cacheFlag.d.ts","sourceRoot":"","sources":["../../src/functions/cacheFlag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AA4B1E,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,eAAe,CAAC,CAYtB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAE7E;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iCAAiC,CAC/C,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE,CAYnB"}