isaacscript-common 6.8.0 → 6.10.1

package/src/features/customStage/init.ts

@@ -24,7 +24,11 @@ import {
 } from "./customStageGridEntities";
 import * as metadataJSON from "./metadata.json"; // This will correspond to "metadata.lua" at run-time.
 import { setShadows } from "./shadows";
-import { streakTextGetShaderParams, streakTextPostRender } from "./streakText";
+import {
+  streakTextGetShaderParams,
+  streakTextPostGameStarted,
+  streakTextPostRender,
+} from "./streakText";
 import v, { customStagesMap } from "./v";
 import {
   playVersusScreenAnimation,
@@ -36,20 +40,17 @@ export function customStageInit(mod: ModUpgraded): void {
   initRoomTypeMaps();
 
   mod.AddCallback(ModCallback.POST_RENDER, postRender); // 2
-
+  mod.AddCallback(ModCallback.POST_GAME_STARTED, postGameStarted); // 15
   mod.AddCallback(ModCallback.GET_SHADER_PARAMS, getShaderParams); // 21
-
   mod.AddCallbackCustom(
     ModCallbackCustom.POST_GRID_ENTITY_BROKEN,
     postGridEntityBrokenRockAlt,
     GridEntityType.ROCK_ALT,
   );
-
   mod.AddCallbackCustom(
     ModCallbackCustom.POST_GRID_ENTITY_INIT,
     postGridEntityBrokenInit,
   );
-
   mod.AddCallbackCustom(
     ModCallbackCustom.POST_NEW_ROOM_REORDERED,
     postNewRoomReordered,
@@ -123,15 +124,26 @@ function postRender() {
     return;
   }
 
-  streakTextPostRender(customStage);
+  streakTextPostRender();
   versusScreenPostRender();
 }
 
+// ModCallback.POST_GAME_STARTED (15)
+function postGameStarted() {
+  // We don't early return here because we need to unconditionally reset the sprites.
+  streakTextPostGameStarted();
+}
+
 // ModCallback.GET_SHADER_PARAMS (22)
 function getShaderParams(
   shaderName: string,
 ): Record<string, unknown> | undefined {
-  streakTextGetShaderParams(shaderName);
+  const customStage = v.run.currentCustomStage;
+  if (customStage === null) {
+    return;
+  }
+
+  streakTextGetShaderParams(customStage, shaderName);
   return undefined;
 }
 

package/src/features/customStage/streakText.ts

@@ -1,43 +1,308 @@
+import { ButtonAction, ControllerIndex } from "isaac-typescript-definitions";
 import { fonts, game } from "../../cachedClasses";
-import { KColorDefault } from "../../constants";
-import { getScreenBottomCenterPos } from "../../functions/ui";
-import { todo } from "../../functions/utils";
+import { KColorDefault, VectorOne } from "../../constants";
+import { getEnumValues } from "../../functions/enums";
+import {
+  getScreenBottomCenterPos,
+  getScreenTopCenterPos,
+} from "../../functions/ui";
 import { CustomStage } from "../../interfaces/CustomStage";
 import v from "./v";
 
+enum UIStreakAnimation {
+  TEXT = "Text",
+  TEXT_IN = "TextIn",
+  TEXT_OUT = "TextOut",
+  TEXT_STAY = "TextStay",
+}
+
 /** This must match the name of the shader in "shaders.xml". */
 const EMPTY_SHADER_NAME = "IsaacScript-RenderAboveHUD";
 
-/** This matches the offset that the vanilla game uses. */
-const STREAK_TEXT_BOTTOM_OFFSET = Vector(0, -60);
+/**
+ * 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, 48.25);
+
+/** 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;
+
+/** Corresponds to the vanilla value; determined through trial and error. */
+const TEXT_PLAYBACK_SPEED = 0.5;
+
+/** 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),
+];
+
+/**
+ * We do not actually need to render this sprite at all. It's only purpose is to be an invisible
+ * reference for when and where we need to render the stage's name. Thus, we specify "false" for
+ * "loadGraphics", but still manage playing its animations in the code below.
+ */
+const topStreakSprite = Sprite();
+topStreakSprite.Load("resources/gfx/ui/ui_streak.anm2", false);
+topStreakSprite.PlaybackSpeed = TEXT_PLAYBACK_SPEED;
+
+/**
+ * We do not actually need to render this sprite at all. It's only purpose is to be an invisible
+ * reference for when and where we need to render the stage's name. Thus, we specify "false" for
+ * "loadGraphics", but still manage playing its animations in the code below.
+ */
+const bottomStreakSprite = Sprite();
+bottomStreakSprite.Load("resources/gfx/ui/ui_streak.anm2", false);
+bottomStreakSprite.PlaybackSpeed = TEXT_PLAYBACK_SPEED;
 
 // ModCallback.POST_RENDER (2)
-export function streakTextPostRender(customStage: CustomStage): void {
-  if (!v.run.showingStreakText) {
+export function streakTextPostRender(): void {
+  // The top streak only plays when the player arrives on the floor (or continues a game from the
+  // main menu.)
+  checkEndTopStreakText();
+
+  // The bottom streak only plays when the player holds down the map button.
+  trackMapInputPressed();
+  checkStartBottomStreakText();
+  checkEndBottomStreakText();
+}
+
+function checkEndTopStreakText() {
+  if (
+    v.run.topStreakTextStartedRenderFrame === null ||
+    !topStreakSprite.IsPlaying(UIStreakAnimation.TEXT_STAY)
+  ) {
     return;
   }
 
-  const isPaused = game.IsPaused();
-  if (isPaused) {
+  const renderFrameCount = Isaac.GetFrameCount();
+  const elapsedFrames =
+    renderFrameCount - v.run.topStreakTextStartedRenderFrame;
+  if (elapsedFrames >= 115) {
+    playTextOut(topStreakSprite);
+  }
+}
+
+function trackMapInputPressed() {
+  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() {
+  if (bottomStreakSprite.IsPlaying()) {
     return;
   }
 
-  const font = fonts.upheaval;
-  const length = font.GetStringWidthUTF8(customStage.name);
-  const bottomCenterPos = getScreenBottomCenterPos();
-  const position = bottomCenterPos.add(STREAK_TEXT_BOTTOM_OFFSET);
-  const adjustedX = position.X - length / 2;
-  font.DrawString(customStage.name, adjustedX, position.Y, KColorDefault);
+  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) {
+    bottomStreakSprite.Play(UIStreakAnimation.TEXT, true);
+  }
+}
+
+/**
+ * If the map input has been released, play the animation where the level streak slides out to the
+ * right.
+ */
+function checkEndBottomStreakText() {
+  if (!bottomStreakSprite.IsPlaying(UIStreakAnimation.TEXT_STAY)) {
+    return;
+  }
+
+  const pushedMapFrames = [
+    ...v.run.controllerIndexPushingMapRenderFrame.values(),
+  ];
+  if (pushedMapFrames.length === 0) {
+    playTextOut(bottomStreakSprite);
+  }
 }
 
-// ModCallback.INPUT_ACTION (13)
-// TODO
+// ModCallback.POST_GAME_STARTED (15)
+export function streakTextPostGameStarted(): void {
+  topStreakSprite.Stop();
+  bottomStreakSprite.Stop();
+}
 
 // ModCallback.GET_SHADER_PARAMS (22)
-export function streakTextGetShaderParams(shaderName: string): void {
+export function streakTextGetShaderParams(
+  customStage: CustomStage,
+  shaderName: string,
+): void {
   if (shaderName !== EMPTY_SHADER_NAME) {
     return;
   }
 
-  todo();
+  const topCenterPos = getScreenTopCenterPos();
+  const topStreakPosition = topCenterPos.add(STREAK_SPRITE_TOP_OFFSET);
+  renderSprite(customStage, topStreakSprite, topStreakPosition);
+
+  const bottomCenterPos = getScreenBottomCenterPos();
+  const bottomStreakPosition = bottomCenterPos.add(STREAK_SPRITE_BOTTOM_OFFSET);
+  renderSprite(customStage, bottomStreakSprite, bottomStreakPosition);
+}
+
+function renderSprite(
+  customStage: CustomStage,
+  sprite: Sprite,
+  position: Vector,
+) {
+  sprite.Update();
+  if (!sprite.IsPlaying()) {
+    return;
+  }
+
+  const animation = sprite.GetAnimation() as UIStreakAnimation;
+  const frame = sprite.GetFrame();
+  if (animation === UIStreakAnimation.TEXT && frame === TEXT_STAY_FRAME) {
+    sprite.Play(UIStreakAnimation.TEXT_STAY, true);
+  }
+
+  const isPaused = game.IsPaused();
+  if (isPaused) {
+    return;
+  }
+
+  const font = fonts.upheaval;
+  const { name } = customStage;
+  const length = font.GetStringWidthUTF8(name);
+  const centeredX = position.X - length / 2;
+
+  let adjustment = 0;
+  let scale = VectorOne;
+  switch (animation) {
+    case UIStreakAnimation.TEXT: {
+      if (frame < TEXT_STAY_FRAME) {
+        adjustment = TEXT_IN_ADJUSTMENTS[frame] ?? 0;
+        scale = TEXT_IN_SCALES[frame] ?? VectorOne;
+      } else {
+        const adjustedFrame = frame - TEXT_OUT_FRAME;
+        adjustment = TEXT_OUT_ADJUSTMENTS[adjustedFrame] ?? 0;
+        scale = TEXT_OUT_SCALES[adjustedFrame] ?? VectorOne;
+      }
+
+      break;
+    }
+
+    case UIStreakAnimation.TEXT_IN: {
+      adjustment = TEXT_IN_ADJUSTMENTS[frame] ?? 0;
+      scale = TEXT_IN_SCALES[frame] ?? VectorOne;
+      break;
+    }
+
+    case UIStreakAnimation.TEXT_OUT: {
+      adjustment = TEXT_OUT_ADJUSTMENTS[frame] ?? 0;
+      scale = TEXT_OUT_SCALES[frame] ?? VectorOne;
+      break;
+    }
+
+    default: {
+      break;
+    }
+  }
+
+  const adjustedX = centeredX + adjustment;
+  const adjustedY = position.Y + STREAK_TEXT_BOTTOM_Y_OFFSET;
+
+  sprite.RenderLayer(0, position);
+  font.DrawStringScaled(
+    name,
+    adjustedX,
+    adjustedY,
+    scale.X,
+    scale.Y,
+    KColorDefault,
+  );
+}
+
+function playTextOut(sprite: Sprite) {
+  sprite.Play(UIStreakAnimation.TEXT, true);
+  // We adjust by 2 to roughly align with the speed of the vanilla animation.
+  sprite.SetFrame(TEXT_OUT_FRAME - 2);
+}
+
+export function topStreakTextStart(): 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.topStreakTextStartedRenderFrame = renderFrameCount;
+  topStreakSprite.Play(UIStreakAnimation.TEXT, true);
 }

package/src/features/customStage/v.ts

@@ -1,10 +1,15 @@
+import { ControllerIndex } from "isaac-typescript-definitions";
 import { CustomStage } from "../../interfaces/CustomStage";
 
 const v = {
   run: {
     currentCustomStage: null as CustomStage | null,
-    showingStreakText: false,
     showingBossVersusScreen: false,
+
+    /** Values are the render frame that the controller first pressed the map button. */
+    controllerIndexPushingMapRenderFrame: new Map<ControllerIndex, int>(),
+
+    topStreakTextStartedRenderFrame: null as int | null,
   },
 
   room: {

package/src/features/customStage/versusScreen.ts

@@ -91,15 +91,12 @@ versusScreenBackgroundSprite.Load("gfx/ui/boss/versusscreen.anm2", true);
 const versusScreenDirtSpotSprite = Sprite();
 versusScreenDirtSpotSprite.Load("gfx/ui/boss/versusscreen.anm2", true);
 
-export function playVersusScreenAnimation(
-  customStage: CustomStage,
-  force = false,
-): void {
+export function playVersusScreenAnimation(customStage: CustomStage): void {
   const room = game.GetRoom();
   const roomType = room.GetType();
   const hud = game.GetHUD();
 
-  if (roomType !== RoomType.BOSS && !force) {
+  if (roomType !== RoomType.BOSS) {
     return;
   }
 

package/src/features/extraConsoleCommands/init.ts

@@ -218,6 +218,7 @@ function initMap() {
   );
   extraConsoleCommandsFunctionMap.set("room", commands.roomCommand);
   extraConsoleCommandsFunctionMap.set("rottenHearts", commands.rottenHearts);
+  extraConsoleCommandsFunctionMap.set("runTests", commands.runTests);
   extraConsoleCommandsFunctionMap.set("s", commands.s);
   extraConsoleCommandsFunctionMap.set("sacrifice", commands.sacrifice);
   extraConsoleCommandsFunctionMap.set("secret", commands.secret);

package/src/features/extraConsoleCommands/listCommands.ts

@@ -53,6 +53,7 @@ import { getCardName } from "../../functions/cards";
 import { getCharacterName } from "../../functions/character";
 import { addCharge } from "../../functions/charge";
 import { isValidCollectibleType } from "../../functions/collectibles";
+import { runDeepCopyTests } from "../../functions/deepCopyTests";
 import { getNPCs } from "../../functions/entitiesSpecific";
 import { getEnumValues } from "../../functions/enums";
 import { addFlag } from "../../functions/flag";
@@ -64,6 +65,7 @@ import {
   logSounds,
 } from "../../functions/log";
 import { getMapPartialMatch } from "../../functions/map";
+import { runMergeTests } from "../../functions/mergeTests";
 import {
   spawnCard,
   spawnPill,
@@ -988,6 +990,18 @@ export function rottenHearts(params: string): void {
   addHeart(params, HealthType.ROTTEN);
 }
 
+/**
+ * Run the suite of tests that prove that the "deepCopy" helper function and the "merge" function
+ * work properly. For more information, see the `runDeepCopyTests` and the `runMergeTests`
+ * functions.
+ *
+ * In general, running the tests is only useful if you are troubleshooting the save data manager.
+ */
+export function runTests(): void {
+  runDeepCopyTests();
+  runMergeTests();
+}
+
 /**
  * Alias for the "stage" command.
  *

package/src/features/saveDataManager/exports.ts

@@ -132,12 +132,7 @@ export function saveDataManager(
 
   // Make a copy of the initial save data so that we can use it to restore the default values later
   // on.
-  const saveDataTable = v as LuaTable<AnyNotNil, unknown>;
-  const saveDataCopy = deepCopy(
-    saveDataTable,
-    SerializationType.NONE,
-    key,
-  ) as SaveData;
+  const saveDataCopy = deepCopy(v, SerializationType.NONE, key) as SaveData;
   saveDataDefaultsMap.set(key, saveDataCopy);
 
   // Store the conditional function for later, if present.
@@ -170,10 +165,10 @@ export function saveDataManagerSave(): void {
 }
 
 /** "g" stands for "globals". */
-declare let g: LuaTable<string, SaveData>; // eslint-disable-line @typescript-eslint/no-unused-vars
+declare let g: LuaMap<string, SaveData>; // eslint-disable-line @typescript-eslint/no-unused-vars
 
 /** "gd" stands for "globals defaults". */
-declare let gd: LuaTable<string, SaveData>; // eslint-disable-line @typescript-eslint/no-unused-vars
+declare let gd: LuaMap<string, SaveData>; // eslint-disable-line @typescript-eslint/no-unused-vars
 
 /**
  * - Sets the global variable of "g" equal to all of the save data variables for this mod.

package/src/features/saveDataManager/load.ts

@@ -13,7 +13,7 @@ const DEFAULT_MOD_DATA = "{}";
 
 export function loadFromDisk(
   mod: Mod,
-  oldSaveData: LuaTable<string, SaveData>,
+  oldSaveData: LuaMap<string, SaveData>,
 ): void {
   if (!mod.HasData()) {
     // There is no "save#.dat" file for this save slot.
@@ -47,7 +47,6 @@ export function loadFromDisk(
 
       // Ignore elements that represent subscriptions that no longer exist in the current save data.
       const oldSaveDataForSubscriber = oldSaveData.get(key);
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
       if (oldSaveDataForSubscriber === undefined) {
         return;
       }
@@ -60,7 +59,7 @@ export function loadFromDisk(
       // We do not want to blow away the child tables of the existing map, because save data could
       // contain out-of-date fields. Instead, merge it one field at a time in a recursive way (and
       // convert Lua tables back to TypeScriptToLua Maps, if necessary).
-      merge(oldSaveDataForSubscriber as LuaTable, value, key);
+      merge(oldSaveDataForSubscriber as LuaMap<AnyNotNil, unknown>, value, key);
     },
     SAVE_DATA_MANAGER_DEBUG,
   );

package/src/features/saveDataManager/main.ts

@@ -129,7 +129,6 @@ export function restoreDefaultSaveData(
 
   // Get the default values for this feature.
   const saveDataDefaults = saveDataDefaultsMap.get(subscriberName);
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (saveDataDefaults === undefined) {
     logError(
       `Failed to find the default copy of the save data for subscriber: ${subscriberName}`,
@@ -151,13 +150,13 @@ export function restoreDefaultSaveData(
     childTableDefaults,
     SerializationType.NONE,
     `${subscriberName} --> ${saveDataKey}`,
-  ) as LuaTable<AnyNotNil, unknown>;
+  ) as LuaMap<AnyNotNil, unknown>;
 
   // We do not want to blow away the existing child table because we don't want to break any
   // existing references. Instead, empty the table and copy all of the elements from the copy of the
   // defaults table.
   clearAndCopyAllElements(
-    childTable as unknown as LuaTable,
+    childTable as unknown as LuaMap<AnyNotNil, unknown>,
     childTableDefaultsCopy,
   );
 }
@@ -167,8 +166,8 @@ export function restoreDefaultSaveData(
  * table to the old table.
  */
 function clearAndCopyAllElements(
-  oldTable: LuaTable<AnyNotNil, unknown>,
-  newTable: LuaTable<AnyNotNil, unknown>,
+  oldTable: LuaMap<AnyNotNil, unknown>,
+  newTable: LuaMap<AnyNotNil, unknown>,
 ) {
   clearTable(oldTable);
 

package/src/features/saveDataManager/maps.ts

@@ -5,7 +5,7 @@ import { SaveData } from "../../interfaces/SaveData";
  * Maps for the master map so that we can access the variables via the in-game console when
  * debugging. (TSTL Maps don't expose the map keys as normal keys.)
  */
-export const saveDataMap = new LuaTable<string, SaveData>();
+export const saveDataMap = new LuaMap<string, SaveData>();
 
-export const saveDataDefaultsMap = new LuaTable<string, SaveData>();
-export const saveDataConditionalFuncMap = new Map<string, () => boolean>();
+export const saveDataDefaultsMap = new LuaMap<string, SaveData>();
+export const saveDataConditionalFuncMap = new LuaMap<string, () => boolean>();

package/src/features/saveDataManager/merge.ts

@@ -12,7 +12,7 @@ import { isDefaultMap, isTSTLMap, isTSTLSet } from "../../functions/tstlClass";
 import { isTable } from "../../functions/types";
 import { getTraversalDescription } from "../../functions/utils";
 import { SAVE_DATA_MANAGER_DEBUG } from "./saveDataManagerConstants";
-import { isSerializationBrand } from "./serializationBrand";
+import { isSerializationBrand } from "./serializationBrands";
 
 /**
  * `merge` takes the values from a new table and recursively merges them into an old object (while
@@ -20,7 +20,7 @@ import { isSerializationBrand } from "./serializationBrand";
  *
  * It supports the following object types:
  *
- * - `LuaTable` / basic TSTL objects
+ * - Basic TSTL objects / tables
  * - TSTL `Map`
  * - TSTL `Set`
  * - TSTL classes
@@ -38,10 +38,10 @@ import { isSerializationBrand } from "./serializationBrand";
  */
 export function merge(
   oldObject:
-    | LuaTable<AnyNotNil, unknown>
+    | LuaMap<AnyNotNil, unknown>
     | Map<AnyNotNil, unknown>
     | Set<AnyNotNil>,
-  newTable: LuaTable<AnyNotNil, unknown>,
+  newTable: LuaMap<AnyNotNil, unknown>,
   traversalDescription: string,
 ): void {
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
@@ -73,8 +73,8 @@ export function merge(
 }
 
 function mergeArray(
-  oldArray: LuaTable<AnyNotNil, unknown>,
-  newArray: LuaTable<AnyNotNil, unknown>,
+  oldArray: LuaMap<AnyNotNil, unknown>,
+  newArray: LuaMap<AnyNotNil, unknown>,
 ) {
   // Assume that we should blow away all array values with whatever is present in the incoming
   // array.
@@ -90,7 +90,7 @@ function mergeArray(
 
 function mergeTSTLObject(
   oldObject: Map<AnyNotNil, unknown> | Set<AnyNotNil>,
-  newTable: LuaTable<AnyNotNil, unknown>,
+  newTable: LuaMap<AnyNotNil, unknown>,
   traversalDescription: string,
 ) {
   // We blow away the old object and recursively copy over all of the incoming values.
@@ -140,8 +140,8 @@ function mergeTSTLObject(
 }
 
 function mergeTable(
-  oldTable: LuaTable<AnyNotNil, unknown>,
-  newTable: LuaTable<AnyNotNil, unknown>,
+  oldTable: LuaMap<AnyNotNil, unknown>,
+  newTable: LuaMap<AnyNotNil, unknown>,
   traversalDescription: string,
 ) {
   iterateTableInOrder(
@@ -170,12 +170,12 @@ function mergeTable(
       }
 
       if (isTable(value)) {
-        let oldValue = oldTable.get(key) as LuaTable<AnyNotNil, unknown>;
+        let oldValue = oldTable.get(key) as LuaMap<AnyNotNil, unknown>;
         if (!isTable(oldValue)) {
           // The child table does not exist on the old table. However, we still need to copy over
           // the new table, because we need to handle data types like "Foo | null". Thus, set up a
           // blank sub-table on the old table, and continue to recursively merge..
-          oldValue = new LuaTable();
+          oldValue = new LuaMap();
           oldTable.set(key, oldValue);
         }
 

package/src/features/saveDataManager/save.ts

@@ -11,8 +11,8 @@ import {
 
 export function saveToDisk(
   mod: Mod,
-  saveDataMap: LuaTable<string, SaveData>,
-  saveDataConditionalFuncMap: Map<string, () => boolean>,
+  saveDataMap: LuaMap<string, SaveData>,
+  saveDataConditionalFuncMap: LuaMap<string, () => boolean>,
 ): void {
   const allSaveData = getAllSaveDataToWriteToDisk(
     saveDataMap,
@@ -26,10 +26,10 @@ export function saveToDisk(
 }
 
 function getAllSaveDataToWriteToDisk(
-  saveDataMap: LuaTable<string, SaveData>,
-  saveDataConditionalFuncMap: Map<string, () => boolean>,
+  saveDataMap: LuaMap<string, SaveData>,
+  saveDataConditionalFuncMap: LuaMap<string, () => boolean>,
 ) {
-  const allSaveData = new LuaTable<AnyNotNil, unknown>();
+  const allSaveData = new LuaMap<AnyNotNil, unknown>();
 
   iterateTableInOrder(
     saveDataMap,
@@ -60,7 +60,7 @@ function getAllSaveDataToWriteToDisk(
       // that is unnecessary. Make a copy of the data and recursively convert all TypeScriptToLua
       // Maps into Lua tables.
       const saveDataCopy = deepCopy(
-        saveDataWithoutRoom as LuaTable,
+        saveDataWithoutRoom as LuaMap,
         SerializationType.SERIALIZE,
         subscriberName,
       );