isaacscript-common 14.2.0 → 15.0.0

package/src/classes/features/other/customStages/streakText.ts

@@ -0,0 +1,315 @@
+import { ButtonAction, ControllerIndex } from "isaac-typescript-definitions";
+import { fonts, game } from "../../../../core/cachedClasses";
+import { KColorDefault, VectorOne } from "../../../../core/constants";
+import { UIStreakAnimation } from "../../../../enums/private/UIStreakAnimation";
+import { getEnumValues } from "../../../../functions/enums";
+import {
+  getScreenBottomCenterPos,
+  getScreenTopCenterPos,
+} from "../../../../functions/ui";
+import { CustomStage } from "../../../../interfaces/private/CustomStage";
+
+/** Corresponds to "resources/gfx/ui/ui_streak.anm2". */
+const UI_STREAK_ANIMATION_END_FRAMES: {
+  readonly [key in UIStreakAnimation]: int;
+} = {
+  [UIStreakAnimation.NONE]: 0,
+  [UIStreakAnimation.TEXT]: 69,
+  [UIStreakAnimation.TEXT_STAY]: 1,
+} as const;
+
+/** This must match the name of the shader in "shaders.xml". */
+const EMPTY_SHADER_NAME = "IsaacScript-RenderAboveHUD";
+
+/**
+ * The frame of the "Text" animation that corresponds to when it reaches the center of the screen
+ * and stays put.
+ */
+const TEXT_STAY_FRAME = 8;
+
+/** The frame of the "Text" animation that corresponds to when it starts to move right. */
+const TEXT_OUT_FRAME = 60;
+
+/** This matches the offset that the vanilla game uses; determined via trial and error. */
+const STREAK_SPRITE_TOP_OFFSET = Vector(0, 47);
+
+/** This matches the offset that the vanilla game uses; determined via trial and error. */
+const STREAK_SPRITE_BOTTOM_OFFSET = Vector(0, -48.25);
+
+/**
+ * The offset from the bottom of the sprite that the rendered text should go; determined via trial
+ * and error.
+ */
+const STREAK_TEXT_BOTTOM_Y_OFFSET = -9;
+
+/**
+ * Corresponds to the vanilla value; determined via trial and error.
+ *
+ * 8 is too little and 9 has the vanilla text come out just slightly ahead, so we go with 9.
+ */
+const NUM_RENDER_FRAMES_MAP_HELD_BEFORE_STREAK_TEXT = 11;
+
+/** Taken from StageAPI. */
+const TEXT_IN_ADJUSTMENTS = [-800, -639, -450, -250, -70, 10, 6, 3];
+
+/** Taken from StageAPI. */
+const TEXT_OUT_ADJUSTMENTS = [0, -5, -10, -15, -20, 144, 308, 472, 636, 800];
+
+/** Taken from StageAPI. */
+const TEXT_IN_SCALES = [
+  Vector(3, 0.2),
+  Vector(2.6, 0.36),
+  Vector(2.2, 0.52),
+  Vector(1.8, 0.68),
+  Vector(1.4, 0.84),
+  Vector(0.95, 1.05),
+  Vector(0.97, 1.03),
+  Vector(0.98, 1.02),
+];
+
+/** Taken from StageAPI. */
+const TEXT_OUT_SCALES = [
+  Vector(1, 1),
+  Vector(0.99, 1.03),
+  Vector(0.98, 1.05),
+  Vector(0.96, 1.08),
+  Vector(0.95, 1.1),
+  Vector(1.36, 0.92),
+  Vector(1.77, 0.74),
+  Vector(2.18, 0.56),
+  Vector(2.59, 0.38),
+  Vector(3, 0.2),
+];
+
+interface StreakTextVars {
+  run: {
+    /** Whether we are on e.g. Caves 1 or Caves 2. */
+    firstFloor: boolean;
+
+    /** Values are the render frame that the controller first pressed the map button. */
+    controllerIndexPushingMapRenderFrame: Map<ControllerIndex, int>;
+
+    topStreakTextStartedRenderFrame: int | null;
+
+    topStreakText: {
+      animation: UIStreakAnimation;
+      frame: int;
+      pauseFrame: boolean;
+    };
+
+    bottomStreakText: {
+      animation: UIStreakAnimation;
+      frame: int;
+      pauseFrame: boolean;
+    };
+  };
+}
+
+// ModCallback.POST_RENDER (2)
+export function streakTextPostRender(v: StreakTextVars): void {
+  // The top streak only plays when the player arrives on the floor (or continues a game from the
+  // main menu.)
+  checkEndTopStreakText(v);
+
+  // The bottom streak only plays when the player holds down the map button.
+  trackMapInputPressed(v);
+  checkStartBottomStreakText(v);
+  checkEndBottomStreakText(v);
+}
+
+function checkEndTopStreakText(v: StreakTextVars) {
+  if (
+    v.run.topStreakTextStartedRenderFrame === null ||
+    v.run.topStreakText.animation !== UIStreakAnimation.TEXT_STAY
+  ) {
+    return;
+  }
+
+  const renderFrameCount = Isaac.GetFrameCount();
+  const elapsedFrames =
+    renderFrameCount - v.run.topStreakTextStartedRenderFrame;
+  if (elapsedFrames >= 115) {
+    v.run.topStreakText.animation = UIStreakAnimation.TEXT;
+    // We adjust by the frame backwards by an arbitrary amount to roughly align with the speed of
+    // the vanilla animation.
+    v.run.topStreakText.frame = TEXT_OUT_FRAME - 2;
+  }
+}
+
+function trackMapInputPressed(v: StreakTextVars) {
+  for (const controllerIndex of getEnumValues(ControllerIndex)) {
+    const gameFrameCount = game.GetFrameCount();
+    const oldPushedMapFrame =
+      v.run.controllerIndexPushingMapRenderFrame.get(controllerIndex);
+    const isPushingMap = Input.IsActionPressed(
+      ButtonAction.MAP,
+      controllerIndex,
+    );
+
+    if (isPushingMap) {
+      if (oldPushedMapFrame === undefined) {
+        v.run.controllerIndexPushingMapRenderFrame.set(
+          controllerIndex,
+          gameFrameCount,
+        );
+      }
+    } else {
+      v.run.controllerIndexPushingMapRenderFrame.delete(controllerIndex);
+    }
+  }
+}
+
+/**
+ * If the map input has been pressed down for long enough, play the animation where the level streak
+ * slides in from the left.
+ */
+function checkStartBottomStreakText(v: StreakTextVars) {
+  if (v.run.bottomStreakText.animation !== UIStreakAnimation.NONE) {
+    return;
+  }
+
+  const pushedMapFrames = [
+    ...v.run.controllerIndexPushingMapRenderFrame.values(),
+  ];
+  if (pushedMapFrames.length === 0) {
+    return;
+  }
+
+  const earliestFrame = Math.min(...pushedMapFrames);
+  const gameFrameCount = game.GetFrameCount();
+  const elapsedFrames = gameFrameCount - earliestFrame;
+  if (elapsedFrames >= NUM_RENDER_FRAMES_MAP_HELD_BEFORE_STREAK_TEXT) {
+    v.run.bottomStreakText.animation = UIStreakAnimation.TEXT;
+    v.run.bottomStreakText.frame = 0;
+  }
+}
+
+/**
+ * If the map input has been released, play the animation where the level streak slides out to the
+ * right.
+ */
+function checkEndBottomStreakText(v: StreakTextVars) {
+  if (v.run.bottomStreakText.animation !== UIStreakAnimation.TEXT_STAY) {
+    return;
+  }
+
+  const pushedMapFrames = [
+    ...v.run.controllerIndexPushingMapRenderFrame.values(),
+  ];
+  if (pushedMapFrames.length === 0) {
+    v.run.bottomStreakText.animation = UIStreakAnimation.TEXT;
+    // We adjust by the frame backwards by an arbitrary amount to roughly align with the speed of
+    // the vanilla animation.
+    v.run.bottomStreakText.frame = TEXT_OUT_FRAME - 2;
+  }
+}
+
+// ModCallback.GET_SHADER_PARAMS (22)
+export function streakTextGetShaderParams(
+  v: StreakTextVars,
+  customStage: CustomStage,
+  shaderName: string,
+): void {
+  if (shaderName !== EMPTY_SHADER_NAME) {
+    return;
+  }
+
+  const topCenterPos = getScreenTopCenterPos();
+  const topStreakPosition = topCenterPos.add(STREAK_SPRITE_TOP_OFFSET);
+  renderStreakText(v, customStage, v.run.topStreakText, topStreakPosition);
+
+  const bottomCenterPos = getScreenBottomCenterPos();
+  const bottomStreakPosition = bottomCenterPos.add(STREAK_SPRITE_BOTTOM_OFFSET);
+  renderStreakText(
+    v,
+    customStage,
+    v.run.bottomStreakText,
+    bottomStreakPosition,
+  );
+}
+
+function renderStreakText(
+  v: StreakTextVars,
+  customStage: CustomStage,
+  streakText: { animation: UIStreakAnimation; frame: int; pauseFrame: boolean },
+  position: Vector,
+) {
+  if (streakText.animation === UIStreakAnimation.NONE) {
+    return;
+  }
+
+  if (streakText.animation !== UIStreakAnimation.TEXT_STAY) {
+    const { pauseFrame } = streakText;
+    streakText.pauseFrame = !streakText.pauseFrame;
+
+    if (!pauseFrame) {
+      streakText.frame++;
+    }
+  }
+
+  const endFrame = UI_STREAK_ANIMATION_END_FRAMES[streakText.animation];
+  if (streakText.frame > endFrame) {
+    streakText.animation = UIStreakAnimation.NONE;
+    streakText.frame = 0;
+    return;
+  }
+
+  if (
+    streakText.animation === UIStreakAnimation.TEXT &&
+    streakText.frame === TEXT_STAY_FRAME
+  ) {
+    streakText.animation = UIStreakAnimation.TEXT_STAY;
+    streakText.frame = 0;
+  }
+
+  const isPaused = game.IsPaused();
+  if (isPaused) {
+    return;
+  }
+
+  const font = fonts.upheaval;
+  const { name } = customStage;
+  const numberSuffix = v.run.firstFloor ? "I" : "II";
+  const nameWithNumberSuffix = `${name} ${numberSuffix}`;
+  const length = font.GetStringWidthUTF8(nameWithNumberSuffix);
+  const centeredX = position.X - length / 2;
+
+  let adjustment = 0;
+  let scale = VectorOne;
+
+  if (streakText.animation === UIStreakAnimation.TEXT) {
+    if (streakText.frame < TEXT_STAY_FRAME) {
+      adjustment = TEXT_IN_ADJUSTMENTS[streakText.frame] ?? 0;
+      scale = TEXT_IN_SCALES[streakText.frame] ?? VectorOne;
+    } else {
+      const adjustedFrame = streakText.frame - TEXT_OUT_FRAME;
+      adjustment = TEXT_OUT_ADJUSTMENTS[adjustedFrame] ?? 0;
+      scale = TEXT_OUT_SCALES[adjustedFrame] ?? VectorOne;
+    }
+  }
+
+  const adjustedX = centeredX + adjustment;
+  const adjustedY = position.Y + STREAK_TEXT_BOTTOM_Y_OFFSET;
+
+  font.DrawStringScaled(
+    nameWithNumberSuffix,
+    adjustedX,
+    adjustedY,
+    scale.X,
+    scale.Y,
+    KColorDefault,
+  );
+}
+
+export function topStreakTextStart(v: StreakTextVars): void {
+  const level = game.GetLevel();
+  const renderFrameCount = Isaac.GetFrameCount();
+
+  // Show the vanilla streak text, which will have a blank name because of the -1 floor.
+  level.ShowName(false);
+
+  // Initiate the animation for the custom text.
+  v.run.topStreakText.animation = UIStreakAnimation.TEXT;
+  v.run.topStreakText.frame = 0;
+  v.run.topStreakTextStartedRenderFrame = renderFrameCount;
+}

package/src/classes/features/other/customStages/utils.ts

@@ -0,0 +1,105 @@
+import { sumArray } from "../../../../functions/array";
+import { log } from "../../../../functions/log";
+import { getRandomFloat } from "../../../../functions/random";
+import { getRandomSeed } from "../../../../functions/rng";
+import {
+  CustomStageBossPoolEntry,
+  CustomStageRoomMetadata,
+} from "../../../../interfaces/CustomStageTSConfig";
+
+/**
+ * Helper function to get a random custom stage room from an array of custom stage rooms.
+ *
+ * Note that this function does not simply choose a random element in the provided array; it will
+ * properly account for each room weight using the algorithm from:
+ * https://stackoverflow.com/questions/1761626/weighted-random-numbers
+ */
+export function getRandomCustomStageRoom(
+  roomsMetadata: readonly CustomStageRoomMetadata[],
+  seedOrRNG: Seed | RNG = getRandomSeed(),
+  verbose = false,
+): CustomStageRoomMetadata {
+  const totalWeight = getTotalWeightOfCustomStageRooms(roomsMetadata);
+  if (verbose) {
+    log(`Total weight of the custom stage rooms provided: ${totalWeight}`);
+  }
+
+  const chosenWeight = getRandomFloat(0, totalWeight, seedOrRNG);
+  if (verbose) {
+    log(`Randomly chose weight for custom stage room: ${chosenWeight}`);
+  }
+
+  return getCustomStageRoomWithChosenWeight(roomsMetadata, chosenWeight);
+}
+
+function getTotalWeightOfCustomStageRooms(
+  roomsMetadata: readonly CustomStageRoomMetadata[],
+): float {
+  const weights = roomsMetadata.map((roomMetadata) => roomMetadata.weight);
+  return sumArray(weights);
+}
+
+function getCustomStageRoomWithChosenWeight(
+  roomsMetadata: readonly CustomStageRoomMetadata[],
+  chosenWeight: float,
+): CustomStageRoomMetadata {
+  for (const roomMetadata of roomsMetadata) {
+    if (chosenWeight < roomMetadata.weight) {
+      return roomMetadata;
+    }
+
+    chosenWeight -= roomMetadata.weight;
+  }
+
+  error(
+    `Failed to get a custom stage room with chosen weight: ${chosenWeight}`,
+  );
+}
+
+export function getRandomBossRoomFromPool(
+  roomsMetadata: readonly CustomStageRoomMetadata[],
+  bossPool: readonly CustomStageBossPoolEntry[],
+  seedOrRNG: Seed | RNG = getRandomSeed(),
+  verbose = false,
+): CustomStageRoomMetadata {
+  const totalWeight = getTotalWeightOfBossPool(bossPool);
+  if (verbose) {
+    log(`Total weight of the custom stage boss pool provided: ${totalWeight}`);
+  }
+
+  const chosenWeight = getRandomFloat(0, totalWeight, seedOrRNG);
+  if (verbose) {
+    log(`Randomly chose weight for custom stage boss pool: ${chosenWeight}`);
+  }
+
+  const bossEntry = getBossEntryWithChosenWeight(bossPool, chosenWeight);
+
+  const roomsMetadataForBoss = roomsMetadata.filter(
+    (roomMetadata) => roomMetadata.subType === bossEntry.subType,
+  );
+  return getRandomCustomStageRoom(roomsMetadataForBoss, seedOrRNG, verbose);
+}
+
+function getTotalWeightOfBossPool(
+  bossPool: readonly CustomStageBossPoolEntry[],
+): float {
+  const weights = bossPool.map((bossEntry) => bossEntry.weight);
+  return sumArray(weights);
+}
+
+function getBossEntryWithChosenWeight(
+  bossPool: readonly CustomStageBossPoolEntry[],
+  chosenWeight: float,
+): CustomStageBossPoolEntry {
+  for (const bossEntry of bossPool) {
+    if (chosenWeight < bossEntry.weight) {
+      return bossEntry;
+    }
+
+    chosenWeight -= bossEntry.weight;
+  }
+
+  error(
+    `Failed to get a custom stage boss entry with chosen weight: ${chosenWeight}`,
+  );
+}