isaacscript-common 6.16.2 → 6.18.0

package/src/features/customGridEntity.ts

@@ -2,6 +2,7 @@ import {
   ActiveSlot,
   CollectibleType,
   DamageFlag,
+  EntityFlag,
   EntityType,
   GridCollisionClass,
   GridEntityType,
@@ -15,7 +16,7 @@ import { ModUpgraded } from "../classes/ModUpgraded";
 import { DecorationVariant } from "../enums/DecorationVariant";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { spawnNPC } from "../functions/entitiesSpecific";
+import { spawn } from "../functions/entities";
 import { hasFlag } from "../functions/flag";
 import {
   removeGridEntity,
@@ -23,22 +24,23 @@ import {
 } from "../functions/gridEntities";
 import { getRoomListIndex } from "../functions/roomData";
 import { isVector } from "../functions/vector";
-import { CustomGridEntityData } from "../interfaces/CustomGridEntityData";
+import { GridEntityCustomData } from "../interfaces/GridEntityCustomData";
 import { runNextGameFrame } from "./runInNFrames";
 import { saveDataManager } from "./saveDataManager/exports";
 
 const FEATURE_NAME = "customGridEntity";
+const GENERIC_PROP_SIZE_MULTIPLIER = 0.66;
 
 const v = {
   level: {
     /** Indexed by room list index and grid index. */
-    customGridEntities: new DefaultMap<int, Map<int, CustomGridEntityData>>(
+    customGridEntities: new DefaultMap<int, Map<int, GridEntityCustomData>>(
       () => new Map(),
     ),
   },
 
   room: {
-    dummyPtrHashes: new Set<PtrHash>(),
+    genericPropPtrHashes: new Set<PtrHash>(),
     manuallyUsingShovel: false,
   },
 };
@@ -49,8 +51,8 @@ export function customGridEntityInit(mod: ModUpgraded): void {
 
   mod.AddCallback(
     ModCallback.ENTITY_TAKE_DMG,
-    entityTakeDmgDummy,
-    EntityType.DUMMY,
+    entityTakeDmgGenericProp,
+    EntityType.GENERIC_PROP,
   ); // 11
 
   mod.AddCallback(
@@ -66,8 +68,8 @@ export function customGridEntityInit(mod: ModUpgraded): void {
 }
 
 // ModCallback.ENTITY_TAKE_DMG (11)
-// EntityType.DUMMY (964)
-function entityTakeDmgDummy(
+// EntityType.GENERIC_PROP (960)
+function entityTakeDmgGenericProp(
   tookDamage: Entity,
   _damageAmount: float,
   damageFlags: BitFlags<DamageFlag>,
@@ -75,7 +77,7 @@ function entityTakeDmgDummy(
   _damageCountdownFrames: int,
 ): boolean | undefined {
   const ptrHash = GetPtrHash(tookDamage);
-  if (!v.room.dummyPtrHashes.has(ptrHash)) {
+  if (!v.room.genericPropPtrHashes.has(ptrHash)) {
     return undefined;
   }
 
@@ -105,8 +107,8 @@ function entityTakeDmgDummy(
 
   postGridEntityCustomBrokenFire(gridEntity, data.gridEntityTypeCustom);
 
-  // Even though the custom grid entity is now broke, we do not want to remove it, as the end-user
-  // could intend for it to persist with different graphics.
+  // 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;
 }
 
@@ -261,6 +263,7 @@ export function spawnCustomGridEntity(
   if (decoration === undefined) {
     error("Failed to spawn a decoration for a custom grid entity.");
   }
+  decoration.CollisionClass = gridCollisionClass;
 
   const sprite = decoration.GetSprite();
   sprite.Load(anm2Path, true);
@@ -270,7 +273,7 @@ export function spawnCustomGridEntity(
       : defaultAnimation;
   sprite.Play(animationToPlay, true);
 
-  const customGridEntityData: CustomGridEntityData = {
+  const customGridEntityData: GridEntityCustomData = {
     gridEntityTypeCustom,
     roomListIndex,
     gridIndex,
@@ -287,8 +290,18 @@ export function spawnCustomGridEntity(
   // the monitoring for explosions in the `ENTITY_TAKE_DMG` callback.
   if (breakable) {
     const position = room.GetGridPosition(gridIndex);
-    const dummy = spawnNPC(EntityType.DUMMY, 0, 0, position);
-    dummy.Visible = false;
+    const entity = spawn(EntityType.GENERIC_PROP, 0, 0, position);
+    entity.ClearEntityFlags(EntityFlag.APPEAR);
+    entity.Visible = false;
+
+    // By default, it is larger than a grid tile, so make it a bit smaller.
+    entity.SizeMulti = Vector(
+      GENERIC_PROP_SIZE_MULTIPLIER,
+      GENERIC_PROP_SIZE_MULTIPLIER,
+    );
+
+    const ptrHash = GetPtrHash(entity);
+    v.room.genericPropPtrHashes.add(ptrHash);
   }
 
   return decoration;
@@ -309,7 +322,7 @@ export function spawnCustomGridEntity(
  * @returns The grid entity that was removed. Returns undefined if no grid entity was found at the
  *          given location or if the given grid entity was not a custom grid entity.
  */
-export function removeCustomGrid(
+export function removeCustomGridEntity(
   gridIndexOrPositionOrGridEntity: int | Vector | GridEntity,
   updateRoom = true,
 ): GridEntity | undefined {
@@ -356,7 +369,7 @@ export function removeCustomGrid(
  * containing the raw decoration grid entity and the associated entity data.
  */
 export function getCustomGridEntities(): Array<
-  [gridEntity: GridEntity, data: CustomGridEntityData]
+  [gridEntity: GridEntity, data: GridEntityCustomData]
 > {
   const roomListIndex = getRoomListIndex();
   const roomCustomGridEntities = v.level.customGridEntities.get(roomListIndex);
@@ -365,7 +378,7 @@ export function getCustomGridEntities(): Array<
   }
 
   const room = game.GetRoom();
-  const customGridEntities: Array<[GridEntity, CustomGridEntityData]> = [];
+  const customGridEntities: Array<[GridEntity, GridEntityCustomData]> = [];
   for (const [gridIndex, data] of roomCustomGridEntities.entries()) {
     const gridEntity = room.GetGridEntity(gridIndex);
     if (gridEntity !== undefined) {

package/src/features/extraConsoleCommands/listCommands.ts

@@ -64,7 +64,7 @@ import { getEnumValues } from "../../functions/enums";
 import { addFlag } from "../../functions/flag";
 import { spawnGridEntity } from "../../functions/gridEntities";
 import {
-  logEffects,
+  logPlayerEffects,
   logRoom,
   logSeedEffects,
   logSounds,
@@ -515,7 +515,7 @@ export function dungeon(): void {
 /** Logs the player's current temporary effects to the "log.txt" file. */
 export function effects(): void {
   const player = Isaac.GetPlayer();
-  logEffects(player);
+  logPlayerEffects(player);
   printConsole('Logged the player\'s effects to the "log.txt" file.');
 }
 

package/src/features/persistentEntities.ts

@@ -8,7 +8,7 @@ import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { spawn } from "../functions/entities";
 import { getRoomListIndex } from "../functions/roomData";
-import { getLatestRoomDescription } from "./roomHistory";
+import { getLatestRoomDescription, isLeavingRoom } from "./roomHistory";
 import { saveDataManager } from "./saveDataManager/exports";
 
 interface PersistentEntityDescription {
@@ -56,6 +56,10 @@ export function persistentEntitiesInit(mod: ModUpgraded): void {
 
 // ModCallback.POST_ENTITY_REMOVE (67)
 function postEntityRemove(entity: Entity) {
+  checkDespawningFromPlayerLeavingRoom(entity);
+}
+
+function checkDespawningFromPlayerLeavingRoom(entity: Entity) {
   const ptrHash = GetPtrHash(entity);
   const tuple = v.room.spawnedPersistentEntities.get(ptrHash);
   if (tuple === undefined) {
@@ -63,10 +67,20 @@ function postEntityRemove(entity: Entity) {
   }
   const index = tuple[0];
 
-  // The persistent entity is despawning, presumably because the player is in the process of leaving
-  // the room. Keep track of the position for later. We use the previous room list index because
-  // even though the `POST_NEW_ROOM` callback was not fired yet, we have already traveled to the
-  // next room.
+  if (!isLeavingRoom()) {
+    return;
+  }
+
+  trackDespawningPickupPosition(entity, index);
+}
+
+/**
+ * The persistent entity is despawning because the player is in the process of leaving the room.
+ * Keep track of the position for later.
+ */
+function trackDespawningPickupPosition(entity: Entity, index: int) {
+  // (The "latest" room description is really the previous room, because the `POST_NEW_ROOM`
+  // callback was not fired yet.)
   const previousRoomDescription = getLatestRoomDescription();
   const previousRoomListIndex = previousRoomDescription.roomListIndex;
   const persistentEntityDescription: PersistentEntityDescription = {

package/src/features/pickupIndex.ts

@@ -14,7 +14,7 @@ import { getRoomListIndex } from "../functions/roomData";
 import { onAscent } from "../functions/stage";
 import { vectorEquals } from "../functions/vector";
 import { PickupIndex } from "../types/PickupIndex";
-import { getLatestRoomDescription } from "./roomHistory";
+import { getLatestRoomDescription, isLeavingRoom } from "./roomHistory";
 import { saveDataManager } from "./saveDataManager/exports";
 
 interface PickupDescription {
@@ -27,7 +27,6 @@ const FEATURE_NAME = "pickupIndex";
 const v = {
   run: {
     pickupCounter: 0 as PickupIndex,
-    currentRoomListIndex: 0,
 
     pickupDataTreasureRooms: new Map<PickupIndex, PickupDescription>(),
     pickupDataBossRooms: new Map<PickupIndex, PickupDescription>(),
@@ -81,9 +80,6 @@ function postPickupInit(pickup: EntityPickup) {
 
   v.run.pickupCounter++;
   v.room.pickupIndexes.set(ptrHash, v.run.pickupCounter);
-
-  // Additionally, keep track of which room we are storing the pointer hashes for.
-  v.run.currentRoomListIndex = getRoomListIndex();
 }
 
 // ModCallback.POST_ENTITY_REMOVE (67)
@@ -99,10 +95,7 @@ function checkDespawningFromPlayerLeavingRoom(entity: Entity) {
     return;
   }
 
-  const roomListIndex = getRoomListIndex();
-  if (roomListIndex === v.run.currentRoomListIndex) {
-    // This is a pickup that is despawning in the current room. For example, it could be a heart
-    // pickup that the player picked up. Thus, we do not need to keep track of it's metadata.
+  if (!isLeavingRoom()) {
     return;
   }
 
@@ -111,13 +104,14 @@ function checkDespawningFromPlayerLeavingRoom(entity: Entity) {
 
 /**
  * This is a pickup that is despawning because the player is in the process of leaving the room.
- * Keep track of the metadata for later. We need to use the previous room list index because even
- * though the `POST_NEW_ROOM` callback was not fired yet, we have already traveled to the next room.
+ * Keep track of the metadata for later.
  */
 function trackDespawningPickupMetadata(
   entity: Entity,
   pickupIndex: PickupIndex,
 ) {
+  // The "latest" room description is really the previous room, because the `POST_NEW_ROOM` callback
+  // was not fired yet.
   const previousRoomDescription = getLatestRoomDescription();
   const previousRoomListIndex = previousRoomDescription.roomListIndex;
   const pickupDescriptions = v.level.pickupData.getAndSetDefault(
@@ -176,10 +170,10 @@ function postNewRoomReordered() {
     }
 
     if (pickupIndex === undefined) {
-      const entityID = getEntityID(pickup);
-      error(
-        `Failed to find a pickup index corresponding to existing pickup: ${entityID}`,
-      );
+      // 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.
+      v.run.pickupCounter++;
+      pickupIndex = v.run.pickupCounter;
     }
 
     const ptrHash = GetPtrHash(pickup);

package/src/features/roomHistory.ts

@@ -10,6 +10,7 @@ import {
   getRoomStageID,
   getRoomSubType,
   getRoomVariant,
+  getRoomVisitedCount,
 } from "../functions/roomData";
 import { RoomDescription } from "../interfaces/RoomDescription";
 import { saveDataManager } from "./saveDataManager/exports";
@@ -45,6 +46,7 @@ function postNewRoomEarly() {
   const roomName = getRoomName();
   const roomGridIndex = getRoomGridIndex();
   const roomListIndex = getRoomListIndex();
+  const roomVisitedCount = getRoomVisitedCount();
 
   const roomDescription: RoomDescription = {
     stage,
@@ -56,6 +58,7 @@ function postNewRoomEarly() {
     roomName,
     roomGridIndex,
     roomListIndex,
+    roomVisitedCount,
   };
   v.run.roomHistory.push(roomDescription);
 }
@@ -96,10 +99,7 @@ export function getPreviousRoomDescription(): RoomDescription {
  * Helper function to get information about the most recent room that is stored in the room history
  * array.
  *
- * This is useful in the `POST_ENTITY_REMOVE` callback, since if an entity is despawning due to a
- * player having left the room, the current room will have changed already, but 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 is useful in the `POST_ENTITY_REMOVE` callback; see the `isLeavingRoom` function.
  */
 export function getLatestRoomDescription(): RoomDescription {
   const latestRoomDescription = getLastElement(v.run.roomHistory);
@@ -111,3 +111,23 @@ export function getLatestRoomDescription(): RoomDescription {
 
   return latestRoomDescription;
 }
+
+/**
+ * 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 function is intended to be used in the `POST_ENTITY_REMOVE` callback to detect when an
+ * entity is pseudo-persistent entity such as a pickup is despawning.
+ */
+export function isLeavingRoom(): boolean {
+  const roomListIndex = getRoomListIndex();
+  const roomVisitedCount = getRoomVisitedCount();
+  const latestRoomDescription = getLatestRoomDescription();
+
+  return (
+    roomListIndex !== latestRoomDescription.roomListIndex ||
+    roomVisitedCount !== latestRoomDescription.roomVisitedCount
+  );
+}

package/src/functions/log.ts

@@ -6,6 +6,7 @@ import {
   GameStateFlag,
   GridEntityType,
   GridRoom,
+  HeartSubType,
   LevelStateFlag,
   ProjectileFlag,
   SeedEffect,
@@ -202,34 +203,6 @@ export function logDamageFlags(
   logFlags(flags, DamageFlag, "damage");
 }
 
-export function logEffects(this: void, player: EntityPlayer): void {
-  const effects = getEffectsList(player);
-
-  log("Logging player effects:");
-
-  if (effects.length === 0) {
-    log("  n/a (no effects)");
-    return;
-  }
-
-  effects.forEach((effect, i) => {
-    let effectDescription: string;
-    if (effect.Item.IsCollectible()) {
-      const collectibleName = getCollectibleName(effect.Item.ID);
-      effectDescription = `Collectible: ${collectibleName}`;
-    } else if (effect.Item.IsTrinket()) {
-      const trinketName = getTrinketName(effect.Item.ID);
-      effectDescription = `Trinket: ${trinketName}`;
-    } else if (effect.Item.IsNull()) {
-      effectDescription = `Null item: ${effect.Item.ID}`;
-    } else {
-      effectDescription = `Unknown type of effect: ${effect.Item.ID}`;
-    }
-
-    log(`  ${i + 1}) ${effectDescription} (x${effect.Count})`);
-  });
-}
-
 /** Helper function for logging an array of specific entities. */
 export function logEntities(this: void, entities: Entity[]): void {
   for (const entity of entities) {
@@ -504,6 +477,34 @@ export function logMap(this: void, map: Map<AnyNotNil, unknown>): void {
   log(`  The size of the map was: ${map.size}`);
 }
 
+export function logPlayerEffects(this: void, player: EntityPlayer): void {
+  const effects = getEffectsList(player);
+
+  log("Logging player effects:");
+
+  if (effects.length === 0) {
+    log("  n/a (no effects)");
+    return;
+  }
+
+  effects.forEach((effect, i) => {
+    let effectDescription: string;
+    if (effect.Item.IsCollectible()) {
+      const collectibleName = getCollectibleName(effect.Item.ID);
+      effectDescription = `Collectible: ${collectibleName}`;
+    } else if (effect.Item.IsTrinket()) {
+      const trinketName = getTrinketName(effect.Item.ID);
+      effectDescription = `Trinket: ${trinketName}`;
+    } else if (effect.Item.IsNull()) {
+      effectDescription = `Null item: ${effect.Item.ID}`;
+    } else {
+      effectDescription = `Unknown type of effect: ${effect.Item.ID}`;
+    }
+
+    log(`  ${i + 1}) ${effectDescription} (x${effect.Count})`);
+  });
+}
+
 export function logPlayerHealth(this: void, player: EntityPlayer): void {
   const playerName = getPlayerName(player);
   const playerHealth = getPlayerHealth(player);
@@ -519,7 +520,11 @@ export function logPlayerHealth(this: void, player: EntityPlayer): void {
   log(`  Broken hearts: ${playerHealth.brokenHearts}`);
   log(`  Soul charges: ${playerHealth.soulCharges}`);
   log(`  Blood charges: ${playerHealth.bloodCharges}`);
-  log(`  Soul heart types: [${playerHealth.soulHeartTypes.join(",")}]`);
+  log("  Soul heart types: [");
+  for (const soulHeartType of playerHealth.soulHeartTypes) {
+    log(`    HeartSubType.${HeartSubType[soulHeartType]}`);
+  }
+  log("  ]");
 }
 
 /**
@@ -764,7 +769,6 @@ export function setLogFunctionsGlobal(): void {
   globals["logArray"] = logArray;
   globals["logColor"] = logColor;
   globals["logDamageFlags"] = logDamageFlags;
-  globals["logEffects"] = logEffects;
   globals["logEntities"] = logEntities;
   globals["logEntity"] = logEntity;
   globals["logEntityID"] = logEntityID;
@@ -777,6 +781,7 @@ export function setLogFunctionsGlobal(): void {
   globals["logKColor"] = logKColor;
   globals["logLevelStateFlags"] = logLevelStateFlags;
   globals["logMap"] = logMap;
+  globals["logPlayerEffects"] = logPlayerEffects;
   globals["logPlayerHealth"] = logPlayerHealth;
   globals["logProjectileFlags"] = logProjectileFlags;
   globals["logRoom"] = logRoom;

package/src/functions/npcs.ts

@@ -6,6 +6,7 @@ import {
   DarkEsauVariant,
   DeathVariant,
   EntityType,
+  HopperVariant,
   MamaGurdyVariant,
   MotherSubType,
   MotherVariant,
@@ -83,17 +84,39 @@ export function isAliveExceptionNPC(npc: EntityNPC): boolean {
     return true;
   }
 
-  if (isRaglingDeathPatch(npc)) {
+  // EntityType.HOPPER (29)
+  // HopperVariant.EGGY (2)
+  if (isDyingEggyWithNoSpidersLeft(npc)) {
     return true;
   }
 
-  if (isDyingEggyWithNoSpidersLeft(npc)) {
+  // EntityType.DADDY_LONG_LEGS (101)
+  if (isDaddyLongLegsChildStompEntity(npc)) {
+    return true;
+  }
+
+  // EntityType.RAGLING (256)
+  if (isRaglingDeathPatch(npc)) {
     return true;
   }
 
   return false;
 }
 
+/**
+ * Helper function to distinguish between a normal Daddy Long Legs / Triachnid and the child entity
+ * that is spawned when the boss does the multi-stomp attack.
+ *
+ * When this attack occurs, four extra copies of Daddy Long Legs will be spawned with the same
+ * entity type, variant, and sub-type. The `Entity.Parent` property will be undefined in this case,
+ * so the way to tell them apart is to check for a non-undefined `Entity.SpawnerEntity` property.
+ */
+export function isDaddyLongLegsChildStompEntity(npc: EntityNPC): boolean {
+  return (
+    npc.Type === EntityType.DADDY_LONG_LEGS && npc.SpawnerEntity !== undefined
+  );
+}
+
 /**
  * Helper function to detect the custom death state of an Eggy. Eggies are never actually marked
  * dead by the game. Instead, when Eggies take fatal damage, they go into NpcState.STATE_SUICIDE and
@@ -101,6 +124,8 @@ export function isAliveExceptionNPC(npc: EntityNPC): boolean {
  */
 export function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean {
   return (
+    npc.Type === EntityType.HOPPER &&
+    npc.Variant === (HopperVariant.EGGY as int) &&
     npc.State === NpcState.SUICIDE &&
     npc.StateFrame >= EGGY_STATE_FRAME_OF_FINAL_SPIDER
   );

package/src/functions/playerHealth.ts

@@ -6,7 +6,7 @@ import {
 } from "isaac-typescript-definitions";
 import { MAX_PLAYER_HEART_CONTAINERS } from "../constants";
 import { HealthType } from "../enums/HealthType";
-import { PlayerHealth } from "../interfaces/PlayerHealth";
+import { PlayerHealth, SoulHeartType } from "../interfaces/PlayerHealth";
 import { getTotalCharge } from "./charge";
 import { getEnumValues } from "./enums";
 import {
@@ -79,7 +79,6 @@ export function addPlayerHealthType(
  */
 export function getPlayerHealth(player: EntityPlayer): PlayerHealth {
   const character = player.GetPlayerType();
-  const soulHeartTypes: HeartSubType[] = [];
   let maxHearts = player.GetMaxHearts();
   let hearts = getPlayerHearts(player); // We use the helper function to remove rotten hearts
   let soulHearts = player.GetSoulHearts();
@@ -115,6 +114,7 @@ export function getPlayerHealth(player: EntityPlayer): PlayerHealth {
   // track which soul heart we're currently at.
   let currentSoulHeart = 0;
 
+  const soulHeartTypes: SoulHeartType[] = [];
   for (let i = 0; i < extraHearts; i++) {
     let isBoneHeart = player.IsBoneHeart(i);
     if (character === PlayerType.THE_FORGOTTEN && subPlayer !== undefined) {
@@ -333,24 +333,37 @@ export function setPlayerHealth(
 
   // Add the soul / black / bone hearts.
   let soulHeartsRemaining = playerHealth.soulHearts;
-  playerHealth.soulHeartTypes.forEach((heartType, i) => {
+  playerHealth.soulHeartTypes.forEach((soulHeartType, i) => {
     const isHalf =
       playerHealth.soulHearts + playerHealth.boneHearts * 2 < (i + 1) * 2;
     let addAmount = 2;
-    if (isHalf || heartType === HeartSubType.BONE || soulHeartsRemaining < 2) {
+    if (
+      isHalf ||
+      soulHeartType === HeartSubType.BONE ||
+      soulHeartsRemaining < 2
+    ) {
       // Fix the bug where a half soul heart to the left of a bone heart will be treated as a full
       // soul heart.
       addAmount = 1;
     }
 
-    if (heartType === HeartSubType.SOUL) {
-      player.AddSoulHearts(addAmount);
-      soulHeartsRemaining -= addAmount;
-    } else if (heartType === HeartSubType.BLACK) {
-      player.AddBlackHearts(addAmount);
-      soulHeartsRemaining -= addAmount;
-    } else if (heartType === HeartSubType.BONE) {
-      player.AddBoneHearts(addAmount);
+    switch (soulHeartType) {
+      case HeartSubType.SOUL: {
+        player.AddSoulHearts(addAmount);
+        soulHeartsRemaining -= addAmount;
+        break;
+      }
+
+      case HeartSubType.BLACK: {
+        player.AddBlackHearts(addAmount);
+        soulHeartsRemaining -= addAmount;
+        break;
+      }
+
+      case HeartSubType.BONE: {
+        player.AddBoneHearts(addAmount);
+        break;
+      }
     }
   });