isaacscript-common 8.4.5 → 8.6.0

package/src/features/customGridEntity.ts

@@ -1,14 +1,11 @@
 import {
   ActiveSlot,
   CollectibleType,
-  DamageFlag,
-  EntityType,
   GridCollisionClass,
   GridEntityType,
   ModCallback,
   UseFlag,
 } from "isaac-typescript-definitions";
-import { postGridEntityCustomBrokenFire } from "../callbacks/subscriptions/postGridEntityCustomBroken";
 import { DefaultMap } from "../classes/DefaultMap";
 import { ModUpgraded } from "../classes/ModUpgraded";
 import { game } from "../core/cachedClasses";
@@ -17,7 +14,6 @@ import {
   areFeaturesInitialized,
   errorIfFeaturesNotInitialized,
 } from "../featuresInitialized";
-import { hasFlag } from "../functions/flag";
 import {
   removeGridEntity,
   spawnGridEntityWithVariant,
@@ -49,12 +45,6 @@ const v = {
 export function customGridEntityInit(mod: ModUpgraded): void {
   saveDataManager(FEATURE_NAME, v);
 
-  mod.AddCallback(
-    ModCallback.ENTITY_TAKE_DMG,
-    entityTakeDmgGenericProp,
-    EntityType.GENERIC_PROP,
-  ); // 11
-
   mod.AddCallback(
     ModCallback.PRE_USE_ITEM,
     preUseItemWeNeedToGoDeeper,
@@ -67,51 +57,6 @@ export function customGridEntityInit(mod: ModUpgraded): void {
   );
 }
 
-// ModCallback.ENTITY_TAKE_DMG (11)
-// EntityType.GENERIC_PROP (960)
-function entityTakeDmgGenericProp(
-  tookDamage: Entity,
-  _damageAmount: float,
-  damageFlags: BitFlags<DamageFlag>,
-  _damageSource: EntityRef,
-  _damageCountdownFrames: int,
-): boolean | undefined {
-  const ptrHash = GetPtrHash(tookDamage);
-  if (!v.room.genericPropPtrHashes.has(ptrHash)) {
-    return undefined;
-  }
-
-  if (!hasFlag(damageFlags, DamageFlag.EXPLOSION)) {
-    return false;
-  }
-
-  const room = game.GetRoom();
-  const roomListIndex = getRoomListIndex();
-  const roomCustomGridEntities = v.level.customGridEntities.get(roomListIndex);
-  if (roomCustomGridEntities === undefined) {
-    return false;
-  }
-
-  const gridIndex = room.GetGridIndex(tookDamage.Position);
-  const data = roomCustomGridEntities.get(gridIndex);
-  if (data === undefined) {
-    return false;
-  }
-
-  const gridEntity = room.GetGridEntity(gridIndex);
-  if (gridEntity === undefined) {
-    error(
-      `Failed to get the grid entity for a custom grid entity that broke at grid index: ${gridIndex}`,
-    );
-  }
-
-  postGridEntityCustomBrokenFire(gridEntity, data.gridEntityTypeCustom);
-
-  // Even though the custom grid entity is now broken, we do not want to remove it, as the end-user
-  // could intend for it to persist with different graphics (or take multiple hits to be destroyed).
-  return false;
-}
-
 // ModCallback.PRE_USE_ITEM (23)
 // CollectibleType.WE_NEED_TO_GO_DEEPER (84)
 function preUseItemWeNeedToGoDeeper(

package/src/features/extraConsoleCommands/init.ts

@@ -1,6 +1,7 @@
 import {
   CacheFlag,
   CollectibleType,
+  DamageFlag,
   EntityType,
   LevelCurse,
   ModCallback,
@@ -348,7 +349,13 @@ function evaluateCacheFlying(player: EntityPlayer) {
 
 // ModCallback.ENTITY_TAKE_DMG (11)
 // EntityType.PLAYER (1)
-function entityTakeDmgPlayer() {
+function entityTakeDmgPlayer(
+  _entity: Entity,
+  _damageAmount: float,
+  _damageFlags: BitFlags<DamageFlag>,
+  _damageSource: EntityRef,
+  _damageCountdownFrames: int,
+) {
   if (v.run.spamBloodRights) {
     return false;
   }

package/src/features/firstLast.ts

@@ -95,11 +95,11 @@ export function getLastCollectibleType(): CollectibleType {
 /**
  * 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 only useful when building collectible type objects. For most purposes, you
+ * should use the `getModdedCollectibleArray` or `getModdedCollectibleSet` helper function instead.
+ *
  * (This function is named differently from the `getVanillaCollectibleTypeRange` function because
  * all modded collectible types are contiguous. Thus, each value represents a real
  * `CollectibleType`.)
@@ -189,6 +189,9 @@ export function getLastTrinketType(): TrinketType {
  *
  * Returns an empty array if there are no modded trinket types.
  *
+ * This function is only useful when building collectible type objects. For most purposes, you
+ * should use the `getModdedCollectibleArray` or `getModdedCollectibleSet` 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).
  */

package/src/features/playerInventory.ts

@@ -3,7 +3,11 @@ import { DefaultMap } from "../classes/DefaultMap";
 import { ModUpgraded } from "../classes/ModUpgraded";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { arrayRemoveInPlace, copyArray } from "../functions/array";
+import {
+  arrayRemoveInPlace,
+  copyArray,
+  getLastElement,
+} from "../functions/array";
 import { isActiveCollectible } from "../functions/collectibles";
 import { getCollectibleArray } from "../functions/collectibleSet";
 import {
@@ -107,9 +111,6 @@ function postCollectibleRemoved(
  * Helper function to get all of the collectibles that the player has gotten so far on this run, in
  * order.
  *
- * Note that this does not include active collectibles that have since been dropped for other
- * collectibles.
- *
  * In the case of inventory initialization or the case where the player rerolls their build in the
  * middle of the run (e.g. with D4), the order of the inventory will not correspond to the order
  * that the items were actually given to the player. In this case, the inventory will be in the
@@ -121,6 +122,10 @@ function postCollectibleRemoved(
  * would not be updated. In vanilla, this situation would never happen, but another mod might do
  * this for some reason. (With that said, the next time that a collectible is normally added or
  * removed, it would trigger a re-scan, and the previous changes would be picked up.)
+ *
+ * @param player The player to get the inventory for.
+ * @param includeActiveCollectibles Optional. If true, will include all active collectibles. Default
+ *                                 is true.
  */
 export function getPlayerInventory(
   player: EntityPlayer,
@@ -139,3 +144,18 @@ export function getPlayerInventory(
     (collectibleType) => !isActiveCollectible(collectibleType),
   );
 }
+
+/**
+ * Helper function to get the last passive collectible that the player picked up. In most cases,
+ * this will be the passive that is removed when the player would use Clicker.
+ *
+ * Returns undefined if the player does not have any passive collectibles.
+ */
+export function getPlayerLastPassiveCollectible(
+  player: EntityPlayer,
+): CollectibleType | undefined {
+  errorIfFeaturesNotInitialized(FEATURE_NAME);
+
+  const inventory = getPlayerInventory(player, false);
+  return getLastElement(inventory);
+}

package/src/functions/bosses.ts

@@ -5,6 +5,7 @@ import {
 } from "isaac-typescript-definitions";
 import { VectorZero } from "../core/constants";
 import {
+  ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET,
   ALL_BOSSES_SET,
   STAGE_TO_COMBINED_BOSS_SET_MAP,
   STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP,
@@ -13,7 +14,6 @@ import { SIN_ENTITY_TYPES_SET } from "../sets/sinEntityTypesSet";
 import { getNPCs, spawnNPC } from "./entitiesSpecific";
 import { getAliveNPCs } from "./npcs";
 import { isRNG } from "./rng";
-import { copySet } from "./set";
 import { asNumber } from "./types";
 import { repeat } from "./utils";
 
@@ -56,10 +56,20 @@ export function getAliveBosses(
  *
  * The set contains strings with the entity type and variant, separated by a period.
  *
+ * Note that this set does not include bosses that do not appear in Boss Rooms (e.g. Krampus, Uriel,
+ * and Gabriel.).
+ *
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
+ *
+ * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!
+ *                           Default is true.
  */
-export function getAllBossesSet(): Set<string> {
-  return copySet(ALL_BOSSES_SET);
+export function getAllBossesSet(
+  includeStoryBosses = true,
+): ReadonlySet<string> {
+  return includeStoryBosses
+    ? ALL_BOSSES_SET
+    : ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET;
 }
 
 /**
@@ -84,7 +94,7 @@ export function getBossSet(
     return undefined;
   }
 
-  return copySet(bossSet);
+  return bossSet;
 }
 
 /**
@@ -117,13 +127,15 @@ export function getBosses(
  *
  * Also see the `getAllBossesSet` and `getBossSet` functions.
  */
-export function getCombinedBossSet(stage: int): Set<string> | undefined {
+export function getCombinedBossSet(
+  stage: int,
+): ReadonlySet<string> | undefined {
   const bossSet = STAGE_TO_COMBINED_BOSS_SET_MAP.get(stage);
   if (bossSet === undefined) {
     return undefined;
   }
 
-  return copySet(bossSet);
+  return bossSet;
 }
 
 /** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */

package/src/functions/collectibleCacheFlag.ts

@@ -3,7 +3,7 @@ import { itemConfig } from "../core/cachedClasses";
 import { getCollectibleArray } from "./collectibleSet";
 import { getEnumValues } from "./enums";
 import { hasFlag } from "./flag";
-import { copySet, getSortedSetValues } from "./set";
+import { getSortedSetValues } from "./set";
 import { repeat } from "./utils";
 
 const CACHE_FLAG_TO_COLLECTIBLES_MAP = new Map<
@@ -51,7 +51,7 @@ export function collectibleHasCacheFlag(
  */
 export function getCollectiblesForCacheFlag(
   cacheFlag: CacheFlag,
-): Set<CollectibleType> {
+): ReadonlySet<CollectibleType> {
   lazyInitCacheFlagMap();
 
   const collectiblesSet = CACHE_FLAG_TO_COLLECTIBLES_MAP.get(cacheFlag);
@@ -59,7 +59,7 @@ export function getCollectiblesForCacheFlag(
     return new Set();
   }
 
-  return copySet(collectiblesSet);
+  return collectiblesSet;
 }
 
 /**

package/src/functions/collectibleSet.ts

@@ -3,17 +3,17 @@ import { itemConfig } from "../core/cachedClasses";
 import { getModdedCollectibleTypes } from "../features/firstLast";
 import { getVanillaCollectibleTypeRange } from "./collectibles";
 
-const ALL_COLLECTIBLES_ARRAY: CollectibleType[] = [];
-const ALL_COLLECTIBLES_SET = new Set<CollectibleType>();
+const ALL_COLLECTIBLE_TYPES_ARRAY: CollectibleType[] = [];
+const ALL_COLLECTIBLE_TYPES_SET = new Set<CollectibleType>();
 
-const VANILLA_COLLECTIBLES_ARRAY: CollectibleType[] = [];
-const VANILLA_COLLECTIBLES_SET = new Set<CollectibleType>();
+const VANILLA_COLLECTIBLE_TYPES_ARRAY: CollectibleType[] = [];
+const VANILLA_COLLECTIBLE_TYPES_SET = new Set<CollectibleType>();
 
-const MODDED_COLLECTIBLES_ARRAY: CollectibleType[] = [];
-const MODDED_COLLECTIBLES_SET = new Set<CollectibleType>();
+const MODDED_COLLECTIBLE_TYPES_ARRAY: CollectibleType[] = [];
+const MODDED_COLLECTIBLE_TYPES_SET = new Set<CollectibleType>();
 
-function lazyInitVanillaCollectibles() {
-  if (VANILLA_COLLECTIBLES_ARRAY.length > 0) {
+function lazyInitVanillaCollectibleTypes() {
+  if (VANILLA_COLLECTIBLE_TYPES_ARRAY.length > 0) {
     return;
   }
 
@@ -22,22 +22,22 @@ function lazyInitVanillaCollectibles() {
     // Vanilla collectible types are not contiguous, so we must check every value.
     const itemConfigItem = itemConfig.GetCollectible(collectibleType);
     if (itemConfigItem !== undefined) {
-      VANILLA_COLLECTIBLES_ARRAY.push(collectibleType);
-      VANILLA_COLLECTIBLES_SET.add(collectibleType);
+      VANILLA_COLLECTIBLE_TYPES_ARRAY.push(collectibleType);
+      VANILLA_COLLECTIBLE_TYPES_SET.add(collectibleType);
     }
   }
 }
 
-function lazyInitModdedCollectibles() {
-  if (MODDED_COLLECTIBLES_ARRAY.length > 0) {
+function lazyInitModdedCollectibleTypes() {
+  if (MODDED_COLLECTIBLE_TYPES_ARRAY.length > 0) {
     return;
   }
 
-  lazyInitVanillaCollectibles();
+  lazyInitVanillaCollectibleTypes();
 
-  for (const collectibleType of VANILLA_COLLECTIBLES_ARRAY) {
-    ALL_COLLECTIBLES_ARRAY.push(collectibleType);
-    ALL_COLLECTIBLES_SET.add(collectibleType);
+  for (const collectibleType of VANILLA_COLLECTIBLE_TYPES_ARRAY) {
+    ALL_COLLECTIBLE_TYPES_ARRAY.push(collectibleType);
+    ALL_COLLECTIBLE_TYPES_SET.add(collectibleType);
   }
 
   const moddedCollectibleTypes = getModdedCollectibleTypes();
@@ -45,11 +45,11 @@ function lazyInitModdedCollectibles() {
     // Modded collectible types are contiguous, but we check every value just in case.
     const itemConfigItem = itemConfig.GetCollectible(collectibleType);
     if (itemConfigItem !== undefined) {
-      MODDED_COLLECTIBLES_ARRAY.push(collectibleType);
-      MODDED_COLLECTIBLES_SET.add(collectibleType);
+      MODDED_COLLECTIBLE_TYPES_ARRAY.push(collectibleType);
+      MODDED_COLLECTIBLE_TYPES_SET.add(collectibleType);
 
-      ALL_COLLECTIBLES_ARRAY.push(collectibleType);
-      ALL_COLLECTIBLES_SET.add(collectibleType);
+      ALL_COLLECTIBLE_TYPES_ARRAY.push(collectibleType);
+      ALL_COLLECTIBLE_TYPES_SET.add(collectibleType);
     }
   }
 }
@@ -65,8 +65,8 @@ function lazyInitModdedCollectibles() {
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getCollectibleArray(): readonly CollectibleType[] {
-  lazyInitModdedCollectibles();
-  return ALL_COLLECTIBLES_ARRAY;
+  lazyInitModdedCollectibleTypes();
+  return ALL_COLLECTIBLE_TYPES_ARRAY;
 }
 
 /**
@@ -79,8 +79,8 @@ export function getCollectibleArray(): readonly CollectibleType[] {
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getCollectibleSet(): ReadonlySet<CollectibleType> {
-  lazyInitModdedCollectibles();
-  return ALL_COLLECTIBLES_SET;
+  lazyInitModdedCollectibleTypes();
+  return ALL_COLLECTIBLE_TYPES_SET;
 }
 
 /**
@@ -93,8 +93,8 @@ export function getCollectibleSet(): ReadonlySet<CollectibleType> {
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getModdedCollectibleArray(): readonly CollectibleType[] {
-  lazyInitModdedCollectibles();
-  return MODDED_COLLECTIBLES_ARRAY;
+  lazyInitModdedCollectibleTypes();
+  return MODDED_COLLECTIBLE_TYPES_ARRAY;
 }
 
 /**
@@ -107,8 +107,8 @@ export function getModdedCollectibleArray(): readonly CollectibleType[] {
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getModdedCollectibleSet(): ReadonlySet<CollectibleType> {
-  lazyInitModdedCollectibles();
-  return MODDED_COLLECTIBLES_SET;
+  lazyInitModdedCollectibleTypes();
+  return MODDED_COLLECTIBLE_TYPES_SET;
 }
 
 /**
@@ -118,8 +118,8 @@ export function getModdedCollectibleSet(): ReadonlySet<CollectibleType> {
  * then use the `getVanillaCollectibleSet` helper function instead.
  */
 export function getVanillaCollectibleArray(): readonly CollectibleType[] {
-  lazyInitVanillaCollectibles();
-  return VANILLA_COLLECTIBLES_ARRAY;
+  lazyInitVanillaCollectibleTypes();
+  return VANILLA_COLLECTIBLE_TYPES_ARRAY;
 }
 
 /**
@@ -129,6 +129,6 @@ export function getVanillaCollectibleArray(): readonly CollectibleType[] {
  * then use the `getVanillaCollectibleArray` helper function instead.
  */
 export function getVanillaCollectibleSet(): ReadonlySet<CollectibleType> {
-  lazyInitVanillaCollectibles();
-  return VANILLA_COLLECTIBLES_SET;
+  lazyInitVanillaCollectibleTypes();
+  return VANILLA_COLLECTIBLE_TYPES_SET;
 }

package/src/functions/collectibleTag.ts

@@ -4,7 +4,6 @@ import { getCollectibleArray } from "./collectibleSet";
 import { getEnumValues } from "./enums";
 import { getFlagName } from "./flag";
 import { getPlayerCollectibleCount } from "./players";
-import { copySet } from "./set";
 
 const TAG_TO_COLLECTIBLE_TYPES_MAP = new Map<
   ItemConfigTag,
@@ -59,7 +58,7 @@ export function collectibleHasTag(
  */
 export function getCollectibleTypesWithTag(
   itemConfigTag: ItemConfigTag,
-): Set<CollectibleType> {
+): ReadonlySet<CollectibleType> {
   // Lazy initialize the map.
   if (TAG_TO_COLLECTIBLE_TYPES_MAP.size === 0) {
     initTagMap();
@@ -72,7 +71,7 @@ export function getCollectibleTypesWithTag(
     );
   }
 
-  return copySet(collectibleTypes);
+  return collectibleTypes;
 }
 
 /** Returns the number of items that a player has towards a particular transformation. */

package/src/functions/eden.ts

@@ -3,7 +3,7 @@ import { isHiddenCollectible, isPassiveCollectible } from "./collectibles";
 import { getCollectibleArray } from "./collectibleSet";
 import { collectibleHasTag } from "./collectibleTag";
 import { getRandomSeed } from "./rng";
-import { copySet, getRandomSetElement } from "./set";
+import { getRandomSetElement } from "./set";
 
 const EDEN_PASSIVE_COLLECTIBLES_SET = new Set<CollectibleType>();
 
@@ -19,13 +19,13 @@ function initCollectibleSet() {
   }
 }
 
-export function getEdenPassives(): Set<CollectibleType> {
+export function getEdenPassives(): ReadonlySet<CollectibleType> {
   // Lazy initialize the set.
   if (EDEN_PASSIVE_COLLECTIBLES_SET.size === 0) {
     initCollectibleSet();
   }
 
-  return copySet(EDEN_PASSIVE_COLLECTIBLES_SET);
+  return EDEN_PASSIVE_COLLECTIBLES_SET;
 }
 
 export function getRandomEdenPassive(

package/src/functions/flag.ts

@@ -119,7 +119,7 @@ export function isEmptyFlag<T extends BitFlag | BitFlag128>(flag: T): boolean {
 }
 
 /**
- * Helper function to determine whether damage to a player in the EntityTakeDmg callback was
+ * Helper function to determine whether damage to a player in the `ENTITY_TAKE_DMG` callback was
  * self-inflicted. For example, damage from a Curse Room door, a Razor, or a Blood Donation Machine
  * would count as self-inflicted damage.
  */

package/src/functions/flying.ts

@@ -47,11 +47,11 @@ const CONDITIONAL_FLYING_COLLECTIBLE_TYPES: readonly CollectibleType[] = [
  */
 export function getFlyingCollectibles(
   pruneConditionalItems: boolean,
-): Set<CollectibleType> {
+): ReadonlySet<CollectibleType> {
   // Instead of manually compiling a list of collectibles that grant flying, we can instead
   // dynamically look for collectibles that have `CacheFlag.FLYING`.
-  const collectiblesWithFlyingCacheFlag = getCollectiblesForCacheFlag(
-    CacheFlag.FLYING,
+  const collectiblesWithFlyingCacheFlag = copySet(
+    getCollectiblesForCacheFlag(CacheFlag.FLYING),
   );
 
   // None of the collectibles with a cache of "all" grant flying, so we can safely remove them from
@@ -80,7 +80,7 @@ export function getFlyingCollectibles(
 export function getFlyingTrinkets(): ReadonlySet<TrinketType> {
   // We use a different algorithm than the "getFlyingCollectibles" function because Azazel's Stump
   // has a cache of "all".
-  return copySet(FLYING_TRINKETS);
+  return FLYING_TRINKETS;
 }
 
 export function hasFlyingTemporaryEffect(player: EntityPlayer): boolean {

package/src/functions/input.ts

@@ -6,7 +6,6 @@ import {
 } from "isaac-typescript-definitions";
 import { KEYBOARD_TO_STRING } from "../maps/keyboardToString";
 import { getEnumValues } from "./enums";
-import { copySet } from "./set";
 import { trimPrefix } from "./string";
 
 const MODIFIER_KEYS: readonly Keyboard[] = [
@@ -52,12 +51,12 @@ export function controllerToString(controller: Controller): string | undefined {
   return trimPrefix(key, "BUTTON_");
 }
 
-export function getMoveActions(): Set<ButtonAction> {
-  return copySet(MOVEMENT_ACTIONS_SET);
+export function getMoveActions(): ReadonlySet<ButtonAction> {
+  return MOVEMENT_ACTIONS_SET;
 }
 
-export function getShootActions(): Set<ButtonAction> {
-  return copySet(SHOOTING_ACTIONS_SET);
+export function getShootActions(): ReadonlySet<ButtonAction> {
+  return SHOOTING_ACTIONS_SET;
 }
 
 /** Iterates over all inputs to determine if a particular button is pressed (i.e. held down). */