isaacscript-common 7.9.0 → 7.11.0

package/src/callbacks/subscriptions/postGameStartedReorderedLast.ts

@@ -0,0 +1,21 @@
+export type PostGameStartedReorderedLastRegisterParameters = [
+  callback: (isContinued: boolean) => void,
+];
+
+const subscriptions: PostGameStartedReorderedLastRegisterParameters[] = [];
+
+export function postGameStartedReorderedLastHasSubscriptions(): boolean {
+  return subscriptions.length > 0;
+}
+
+export function postGameStartedReorderedLastRegister(
+  ...args: PostGameStartedReorderedLastRegisterParameters
+): void {
+  subscriptions.push(args);
+}
+
+export function postGameStartedReorderedLastFire(isContinued: boolean): void {
+  for (const [callback] of subscriptions) {
+    callback(isContinued);
+  }
+}

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.
    *
@@ -742,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:
    *
@@ -1038,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/customStage/backdrop.ts

@@ -14,7 +14,7 @@ import { getRandomArrayElement } from "../../functions/array";
 import { spawnEffectWithSeed } from "../../functions/entitiesSpecific";
 import { newRNG } from "../../functions/rng";
 import { isLRoom, isNarrowRoom } from "../../functions/roomShape";
-import { trimPrefix } from "../../functions/string";
+import { removeCharactersBefore, trimPrefix } from "../../functions/string";
 import { erange, irange } from "../../functions/utils";
 import { CustomStage } from "../../interfaces/private/CustomStage";
 import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./customStageConstants";
@@ -118,7 +118,8 @@ function getBackdropPNGPath(
       : customStage.backdropPNGPaths;
 
   const pathArray = backdrop[backdropKind];
-  return getRandomArrayElement(pathArray, rng);
+  const randomPath = getRandomArrayElement(pathArray, rng);
+  return removeCharactersBefore(randomPath, "gfx/");
 }
 
 function spawnWallEntity(

package/src/features/customStage/customStageGridEntities.ts

@@ -14,6 +14,7 @@ import {
   getTrinkets,
 } from "../../functions/pickupsSpecific";
 import { calculateStageType } from "../../functions/stage";
+import { removeCharactersBefore } from "../../functions/string";
 import { vectorEquals } from "../../functions/vector";
 import { CustomStage } from "../../interfaces/private/CustomStage";
 import { isCustomGridEntity } from "../customGridEntity";
@@ -35,6 +36,11 @@ export function setCustomDecorationGraphics(
     return;
   }
 
+  const pngPath = removeCharactersBefore(
+    customStage.decorationsPNGPath,
+    "gfx/",
+  );
+
   if (isCustomGridEntity(gridEntity)) {
     return;
   }
@@ -48,7 +54,7 @@ export function setCustomDecorationGraphics(
   const fileName = sprite.GetFilename();
   // On Windows, this is: gfx/grid/Props_01_Basement.anm2
   if (fileName.toLowerCase() === "gfx/grid/props_01_basement.anm2") {
-    sprite.ReplaceSpritesheet(0, customStage.decorationsPNGPath);
+    sprite.ReplaceSpritesheet(0, pngPath);
     sprite.LoadGraphics();
   }
 }
@@ -64,6 +70,8 @@ export function setCustomRockGraphics(
     return;
   }
 
+  const pngPath = removeCharactersBefore(customStage.rocksPNGPath, "gfx/");
+
   if (isCustomGridEntity(gridEntity)) {
     return;
   }
@@ -76,10 +84,10 @@ export function setCustomRockGraphics(
   const sprite = gridEntity.GetSprite();
   const fileName = sprite.GetFilename();
   if (fileName === "gfx/grid/grid_rock.anm2") {
-    sprite.ReplaceSpritesheet(0, customStage.rocksPNGPath);
+    sprite.ReplaceSpritesheet(0, pngPath);
     sprite.LoadGraphics();
   } else if (fileName === "gfx/grid/grid_pit.anm2") {
-    sprite.ReplaceSpritesheet(1, customStage.rocksPNGPath);
+    sprite.ReplaceSpritesheet(1, pngPath);
     sprite.LoadGraphics();
   }
 }
@@ -95,6 +103,8 @@ export function setCustomPitGraphics(
     return;
   }
 
+  const pngPath = removeCharactersBefore(customStage.pitsPNGPath, "gfx/");
+
   if (isCustomGridEntity(gridEntity)) {
     return;
   }
@@ -107,7 +117,7 @@ export function setCustomPitGraphics(
   const sprite = gridEntity.GetSprite();
   const fileName = sprite.GetFilename();
   if (fileName === "gfx/grid/grid_pit.anm2") {
-    sprite.ReplaceSpritesheet(0, customStage.pitsPNGPath);
+    sprite.ReplaceSpritesheet(0, pngPath);
     sprite.LoadGraphics();
   }
 }
@@ -136,7 +146,8 @@ export function setCustomDoorGraphics(
   const fileName = sprite.GetFilename();
   const doorPNGPath = getNewDoorPNGPath(customStage, fileName);
   if (doorPNGPath !== undefined) {
-    sprite.ReplaceSpritesheet(0, doorPNGPath);
+    const fixedPath = removeCharactersBefore(doorPNGPath, "gfx/");
+    sprite.ReplaceSpritesheet(0, fixedPath);
     sprite.LoadGraphics();
   }
 }

package/src/features/customStage/shadows.ts

@@ -2,6 +2,7 @@ import { EffectVariant, RoomShape } from "isaac-typescript-definitions";
 import { game } from "../../core/cachedClasses";
 import { getRandomArrayElement } from "../../functions/array";
 import { spawnEffectWithSeed } from "../../functions/entitiesSpecific";
+import { removeCharactersBefore } from "../../functions/string";
 import { CustomStage } from "../../interfaces/private/CustomStage";
 import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "./customStageConstants";
 import v from "./v";
@@ -68,7 +69,8 @@ export function setShadows(customStage: CustomStage): void {
   sprite.Load(`${ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH}/stage-shadow.anm2`, false);
   const decorationSeed = room.GetDecorationSeed();
   const shadow = getRandomArrayElement(shadows, decorationSeed);
-  sprite.ReplaceSpritesheet(0, shadow.pngPath);
+  const pngPath = removeCharactersBefore(shadow.pngPath, "gfx/");
+  sprite.ReplaceSpritesheet(0, pngPath);
   sprite.LoadGraphics();
   sprite.SetFrame(animation, 0);
   sprite.Color =

package/src/features/customStage/versusScreen.ts

@@ -10,6 +10,7 @@ import { game, sfxManager } from "../../core/cachedClasses";
 import { arrayRemove } from "../../functions/array";
 import { getBosses } from "../../functions/bosses";
 import { getRoomSubType } from "../../functions/roomData";
+import { removeCharactersBefore } from "../../functions/string";
 import { erange } from "../../functions/utils";
 import { CustomStage } from "../../interfaces/private/CustomStage";
 import { BOSS_NAME_PNG_FILE_NAMES } from "../../objects/bossNamePNGFileNames";
@@ -155,10 +156,18 @@ export function playVersusScreenAnimation(customStage: CustomStage): void {
   // Boss
   {
     const { namePNGPath, portraitPNGPath } = getBossPNGPaths(customStage);
-    versusScreenSprite.ReplaceSpritesheet(BOSS_NAME_ANM2_LAYER, namePNGPath);
+    const trimmedNamePNGPath = removeCharactersBefore(namePNGPath, "gfx/");
     versusScreenSprite.ReplaceSpritesheet(
-      BOSS_PORTRAIT_ANM2_LAYER,
+      BOSS_NAME_ANM2_LAYER,
+      trimmedNamePNGPath,
+    );
+    const trimmedPortraitPNGPath = removeCharactersBefore(
       portraitPNGPath,
+      "gfx/",
+    );
+    versusScreenSprite.ReplaceSpritesheet(
+      BOSS_PORTRAIT_ANM2_LAYER,
+      trimmedPortraitPNGPath,
     );
   }
 

package/src/functions/string.ts

@@ -10,6 +10,18 @@ export function removeAllCharacters(string: string, character: string): string {
   return string.replaceAll(character, "");
 }
 
+/**
+ * Helper function to remove all of the characters in a string before a given substring. Returns the
+ * modified string.
+ */
+export function removeCharactersBefore(
+  string: string,
+  substring: string,
+): string {
+  const index = string.indexOf(substring);
+  return string.slice(index);
+}
+
 /**
  * Helper function to remove one or more substrings from a string, if they exist. Returns the
  * modified string.

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]: