isaacscript-common 7.8.0 → 7.10.0

package/src/enums/ModCallbackCustom.ts

@@ -327,6 +327,18 @@ export enum ModCallbackCustom {
    */
   POST_GAME_STARTED_REORDERED,
 
+  /**
+   * Similar to the `POST_GAME_STARTED_REORDERED` callback, but fires after all of the subscribed
+   * callbacks have finished firing. Thus, you can use this callback to do perform things after a
+   * new run has started (or continued), but you can be sure that all new-run-related initialization
+   * has been completed.
+   *
+   * ```ts
+   * function postGameStartedReorderedLast(isContinued: boolean): void {}
+   * ```
+   */
+  POST_GAME_STARTED_REORDERED_LAST,
+
   /**
    * Fires from the `POST_UPDATE` callback when the Greed Mode wave increases.
    *
@@ -503,6 +515,8 @@ export enum ModCallbackCustom {
    *
    * (Leaving a room with a grid entity does not count as "removing" it.)
    *
+   * This will fire when a Polty/Kineti picks up a grid entity.
+   *
    * When registering the callback, takes an optional second argument that will make the callback
    * only fire if it matches the `GridEntityType` provided.
    *
@@ -740,8 +754,9 @@ export enum ModCallbackCustom {
   POST_NPC_STATE_CHANGED,
 
   /**
-   * Similar to the vanilla callback of the same name, but fires after the `POST_GAME_STARTED`
-   * callback fires (if the player is being updated on the 0th game frame of the run).
+   * Similar to the vanilla callback of the same name, but fires after the
+   * `POST_GAME_STARTED_REORDERED` callback fires (if the player is being updated on the 0th game
+   * frame of the run).
    *
    * This callback is useful for two reasons:
    *
@@ -1036,8 +1051,9 @@ export enum ModCallbackCustom {
   POST_PLAYER_RENDER_REORDERED,
 
   /**
-   * Similar to the vanilla callback of the same name, but fires after the `POST_GAME_STARTED`
-   * callback fires (if the player is being updated on the 0th game frame of the run).
+   * Similar to the vanilla callback of the same name, but fires after the
+   * `POST_GAME_STARTED_REORDERED` callback fires (if the player is being updated on the 0th game
+   * frame of the run).
    *
    * This callback is useful for two reasons:
    *

package/src/features/preventChildEntities.ts

@@ -0,0 +1,44 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import { saveDataManager } from "./saveDataManager/exports";
+
+const FEATURE_NAME = "preventChildEntities";
+
+const v = {
+  room: {
+    preventingEntities: new Set<PtrHash>(),
+  },
+};
+
+export function preventChildEntitiesInit(mod: Mod): void {
+  saveDataManager(FEATURE_NAME, v);
+
+  mod.AddCallback(ModCallback.POST_NPC_INIT, postNPCInit); // 27
+}
+
+// ModCallback.POST_NPC_INIT (27)
+function postNPCInit(npc: EntityNPC) {
+  const spawnerEntityMatch =
+    npc.SpawnerEntity !== undefined &&
+    v.room.preventingEntities.has(GetPtrHash(npc.SpawnerEntity));
+
+  const parentMatch =
+    npc.Parent !== undefined &&
+    v.room.preventingEntities.has(GetPtrHash(npc.Parent));
+
+  if (spawnerEntityMatch || parentMatch) {
+    npc.Remove();
+  }
+}
+
+/**
+ * Helper function to prevent an entity from spawning any other entities. Meant to be used on NPCs
+ * like Squirts. This behavior will only last for the current room.
+ *
+ * Under the hood, this function will remove any new NPCs spawned that have a `Entity.SpawnerEntity`
+ * or `Entity.Parent` value that matches the provided entity. (They are removed during the
+ * `POST_NPC_INIT` callback specifically.)
+ */
+export function preventChildEntities(entity: Entity): void {
+  const ptrHash = GetPtrHash(entity);
+  v.room.preventingEntities.add(ptrHash);
+}

package/src/functions/players.ts

@@ -1065,6 +1065,9 @@ export function useActiveItemTemp(
  *
  * Tainted Magdalene has "permanent" health and "temporary" health. When standing still and doing
  * nothing, all of Tainted Magdalene's temporary health will eventually go away.
+ *
+ * Before using this function, it is expected that you check to see if the player is Tainted
+ * Magdalene first, or else it will give a nonsensical result.
  */
 export function wouldDamageTaintedMagdaleneNonTemporaryHeartContainers(
   player: EntityPlayer,

package/src/index.ts

@@ -57,6 +57,7 @@ export {
   anyPlayerUsingPony,
   isPlayerUsingPony,
 } from "./features/ponyDetection";
+export { preventChildEntities } from "./features/preventChildEntities";
 export { preventCollectibleRotation } from "./features/preventCollectibleRotation";
 export { registerHotkey, unregisterHotkey } from "./features/registerHotkey";
 export {

package/src/initFeatures.ts

@@ -16,6 +16,7 @@ import { persistentEntitiesInit } from "./features/persistentEntities";
 import { pickupIndexInit } from "./features/pickupIndex";
 import { playerInventoryInit } from "./features/playerInventory";
 import { ponyDetectionInit } from "./features/ponyDetection";
+import { preventChildEntitiesInit } from "./features/preventChildEntities";
 import { preventCollectibleRotationInit } from "./features/preventCollectibleRotation";
 import { registerHotkeyInit } from "./features/registerHotkey";
 import { roomClearFrameInit } from "./features/roomClearFrame";
@@ -53,6 +54,7 @@ function initFeaturesMinor(mod: ModUpgraded) {
   pickupIndexInit(mod);
   playerInventoryInit(mod);
   ponyDetectionInit(mod);
+  preventChildEntitiesInit(mod);
   preventCollectibleRotationInit(mod);
   registerHotkeyInit(mod);
   roomClearFrameInit(mod);

package/src/interfaces/private/AddCallbackParameterCustom.ts

@@ -20,6 +20,7 @@ import { PostFirstEsauJrRegisterParameters } from "../../callbacks/subscriptions
 import { PostFirstFlipRegisterParameters } from "../../callbacks/subscriptions/postFirstFlip";
 import { PostFlipRegisterParameters } from "../../callbacks/subscriptions/postFlip";
 import { PostGameStartedReorderedRegisterParameters } from "../../callbacks/subscriptions/postGameStartedReordered";
+import { PostGameStartedReorderedLastRegisterParameters } from "../../callbacks/subscriptions/postGameStartedReorderedLast";
 import { PostGreedModeWaveRegisterParameters } from "../../callbacks/subscriptions/postGreedModeWave";
 import { PostGridEntityBrokenRegisterParameters } from "../../callbacks/subscriptions/postGridEntityBroken";
 import { PostGridEntityCollisionRegisterParameters } from "../../callbacks/subscriptions/postGridEntityCollision";
@@ -114,6 +115,7 @@ export interface AddCallbackParameterCustom {
   [ModCallbackCustom.POST_FIRST_FLIP]: PostFirstFlipRegisterParameters;
   [ModCallbackCustom.POST_FLIP]: PostFlipRegisterParameters;
   [ModCallbackCustom.POST_GAME_STARTED_REORDERED]: PostGameStartedReorderedRegisterParameters;
+  [ModCallbackCustom.POST_GAME_STARTED_REORDERED_LAST]: PostGameStartedReorderedLastRegisterParameters;
   [ModCallbackCustom.POST_GREED_MODE_WAVE]: PostGreedModeWaveRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_BROKEN]: PostGridEntityBrokenRegisterParameters;
   [ModCallbackCustom.POST_GRID_ENTITY_COLLISION]: PostGridEntityCollisionRegisterParameters;

package/src/objects/callbackRegisterFunctions.ts

@@ -20,6 +20,7 @@ import { postFirstEsauJrRegister } from "../callbacks/subscriptions/postFirstEsa
 import { postFirstFlipRegister } from "../callbacks/subscriptions/postFirstFlip";
 import { postFlipRegister } from "../callbacks/subscriptions/postFlip";
 import { postGameStartedReorderedRegister } from "../callbacks/subscriptions/postGameStartedReordered";
+import { postGameStartedReorderedLastRegister } from "../callbacks/subscriptions/postGameStartedReorderedLast";
 import { postGreedModeWaveRegister } from "../callbacks/subscriptions/postGreedModeWave";
 import { postGridEntityBrokenRegister } from "../callbacks/subscriptions/postGridEntityBroken";
 import { postGridEntityCollisionRegister } from "../callbacks/subscriptions/postGridEntityCollision";
@@ -122,6 +123,8 @@ export const CALLBACK_REGISTER_FUNCTIONS: {
   [ModCallbackCustom.POST_FLIP]: postFlipRegister,
   [ModCallbackCustom.POST_GAME_STARTED_REORDERED]:
     postGameStartedReorderedRegister,
+  [ModCallbackCustom.POST_GAME_STARTED_REORDERED_LAST]:
+    postGameStartedReorderedLastRegister,
   [ModCallbackCustom.POST_GREED_MODE_WAVE]: postGreedModeWaveRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_BROKEN]: postGridEntityBrokenRegister,
   [ModCallbackCustom.POST_GRID_ENTITY_COLLISION]: