isaacscript-common 13.3.4 → 14.1.0

package/src/enums/ModCallbackCustom2.ts

@@ -0,0 +1,57 @@
+/** TODO */
+export enum ModCallbackCustom2 {
+  POST_AMBUSH_FINISHED,
+  POST_AMBUSH_STARTED,
+  POST_BOMB_EXPLODED,
+  POST_BOMB_INIT_LATE,
+  POST_BONE_SWING,
+  POST_COLLECTIBLE_EMPTY,
+  POST_COLLECTIBLE_INIT_FIRST,
+  POST_CURSED_TELEPORT,
+  POST_CUSTOM_REVIVE,
+  POST_DICE_ROOM_ACTIVATED,
+  POST_DOOR_RENDER,
+  POST_DOOR_UPDATE,
+  POST_EFFECT_INIT_LATE,
+  POST_EFFECT_STATE_CHANGED,
+  POST_ESAU_JR,
+  POST_FAMILIAR_INIT_LATE,
+  POST_FAMILIAR_STATE_CHANGED,
+  POST_FIRST_ESAU_JR,
+  POST_FIRST_FLIP,
+  POST_FLIP,
+  POST_GAME_STARTED_REORDERED,
+  POST_GAME_STARTED_REORDERED_LAST,
+  POST_GREED_MODE_WAVE,
+  POST_GRID_ENTITY_BROKEN,
+  POST_GRID_ENTITY_COLLISION,
+  POST_GRID_ENTITY_CUSTOM_BROKEN,
+  POST_GRID_ENTITY_CUSTOM_COLLISION,
+  POST_GRID_ENTITY_CUSTOM_INIT,
+  POST_GRID_ENTITY_CUSTOM_REMOVE,
+  // POST_GRID_ENTITY_CUSTOM_RENDER,
+  POST_GRID_ENTITY_CUSTOM_STATE_CHANGED,
+  POST_GRID_ENTITY_CUSTOM_UPDATE,
+  POST_GRID_ENTITY_INIT,
+  POST_GRID_ENTITY_REMOVE,
+  // POST_GRID_ENTITY_RENDER,
+  POST_GRID_ENTITY_STATE_CHANGED,
+  POST_GRID_ENTITY_UPDATE,
+  POST_HOLY_MANTLE_REMOVED,
+
+  // ---------------------
+
+  POST_KNIFE_INIT_LATE,
+  POST_NEW_LEVEL_REORDERED,
+  POST_NEW_ROOM_EARLY,
+  POST_NEW_ROOM_REORDERED,
+  POST_PEFFECT_UPDATE_REORDERED,
+  POST_PIT_RENDER,
+  POST_PLAYER_FATAL_DAMAGE,
+  POST_PLAYER_RENDER_REORDERED,
+  POST_PLAYER_UPDATE_REORDERED,
+  POST_ROOM_CLEAR_CHANGED,
+  POST_SPIKES_RENDER,
+  PRE_BERSERK_DEATH,
+  PRE_CUSTOM_REVIVE,
+}

package/src/features/customGridEntity.ts

@@ -18,6 +18,7 @@ import {
   removeGridEntity,
   spawnGridEntityWithVariant,
 } from "../functions/gridEntities";
+import { getPlayerFromPtr } from "../functions/players";
 import { getRoomListIndex } from "../functions/roomData";
 import { isNumber } from "../functions/types";
 import { isVector } from "../functions/vector";
@@ -91,14 +92,9 @@ function preUseItemWeNeedToGoDeeper(
 
   removeGridEntity(customGridEntity.gridIndex, false);
 
-  const playerPtr = EntityPtr(player);
+  const entityPtr = EntityPtr(player);
   runNextGameFrame(() => {
-    const futureEntity = playerPtr.Ref;
-    if (futureEntity === undefined) {
-      return;
-    }
-
-    const futurePlayer = futureEntity.ToPlayer();
+    const futurePlayer = getPlayerFromPtr(entityPtr);
     if (futurePlayer === undefined) {
       return;
     }

package/src/features/{setHotkey.ts → customHotkeys.ts}

@@ -3,7 +3,7 @@ import { DefaultMap } from "../classes/DefaultMap";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import { isKeyboardPressed } from "../functions/input";
 
-const FEATURE_NAME = "setHotkey";
+const FEATURE_NAME = "customHotkeys";
 
 /**
  * The keys are the keyboard keys that trigger the hotkey. The values are the functions that contain
@@ -23,7 +23,7 @@ const dynamicHotkeyFunctionMap = new Map<
 const keyPressedMap = new DefaultMap<Keyboard, boolean>(false);
 
 /** @internal */
-export function setHotkeyInit(mod: Mod): void {
+export function customHotkeysInit(mod: Mod): void {
   mod.AddCallback(ModCallback.POST_RENDER, postRender); // 2
 }
 

package/src/features/customPickup.ts

@@ -4,12 +4,14 @@ import {
   ModCallback,
   PickupVariant,
 } from "isaac-typescript-definitions";
+import { LadderSubTypeCustom } from "../enums/LadderSubTypeCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import {
   getEntityID,
   getEntityIDFromConstituents,
 } from "../functions/entities";
 import { spawnEffect } from "../functions/entitiesSpecific";
+import { asNumber } from "../functions/types";
 
 const FEATURE_NAME = "customPickup";
 
@@ -27,7 +29,7 @@ interface CustomPickupFunctions {
  * time passes, like most other effects.
  */
 const PICKUP_EFFECT_VARIANT = EffectVariant.LADDER;
-const PICKUP_EFFECT_SUB_TYPE = 103;
+const PICKUP_EFFECT_SUB_TYPE = LadderSubTypeCustom.CUSTOM_PICKUP;
 
 /** Indexed by entity ID. */
 const customPickupFunctionsMap = new Map<string, CustomPickupFunctions>();
@@ -85,7 +87,7 @@ function prePickupCollision(
 // ModCallback.POST_EFFECT_RENDER (56)
 // PICKUP_EFFECT_VARIANT
 function postEffectRenderPickupEffect(effect: EntityEffect) {
-  if (effect.SubType !== PICKUP_EFFECT_SUB_TYPE) {
+  if (effect.SubType !== asNumber(PICKUP_EFFECT_SUB_TYPE)) {
     return;
   }
 

package/src/features/customStage/backdrop.ts

@@ -10,6 +10,7 @@ import {
 } from "isaac-typescript-definitions";
 import { game } from "../../core/cachedClasses";
 import { VectorZero } from "../../core/constants";
+import { LadderSubTypeCustom } from "../../enums/LadderSubTypeCustom";
 import { getRandomArrayElement } from "../../functions/array";
 import { spawnEffectWithSeed } from "../../functions/entitiesSpecific";
 import { newRNG } from "../../functions/rng";
@@ -83,7 +84,7 @@ const N_FLOOR_ANM2_LAYERS: readonly int[] = [18, 19];
  * time passes, like most other effects.
  */
 const BACKDROP_EFFECT_VARIANT = EffectVariant.LADDER;
-const BACKDROP_EFFECT_SUB_TYPE = 101;
+const BACKDROP_EFFECT_SUB_TYPE = LadderSubTypeCustom.CUSTOM_BACKDROP;
 
 const BACKDROP_ROOM_TYPE_SET: ReadonlySet<RoomType> = new Set([
   RoomType.DEFAULT,

package/src/features/customStage/shadows.ts

@@ -1,5 +1,6 @@
 import { EffectVariant, RoomShape } from "isaac-typescript-definitions";
 import { game } from "../../core/cachedClasses";
+import { LadderSubTypeCustom } from "../../enums/LadderSubTypeCustom";
 import { getRandomArrayElement } from "../../functions/array";
 import { spawnEffectWithSeed } from "../../functions/entitiesSpecific";
 import { removeCharactersBefore } from "../../functions/string";
@@ -18,7 +19,7 @@ type ShadowAnimation = "1x1" | "1x2" | "2x1" | "2x2";
  * time passes, like most other effects.
  */
 const SHADOW_EFFECT_VARIANT = EffectVariant.LADDER;
-const SHADOW_EFFECT_SUB_TYPE = 102;
+const SHADOW_EFFECT_SUB_TYPE = LadderSubTypeCustom.CUSTOM_SHADOW;
 
 /** The animation comes from StageAPI. */
 const ROOM_SHAPE_TO_SHADOW_ANIMATION: {

package/src/features/customTrapdoor/init.ts

@@ -125,7 +125,6 @@ function checkPixelationToBlackComplete() {
       startingRoomIndex,
       Direction.NO_DIRECTION,
       RoomTransitionAnim.PIXELATION,
-      true,
     );
   });
 }

package/src/features/customTrapdoor/touched.ts

@@ -123,7 +123,7 @@ function setPlayerAttributes(trapdoorPlayer: EntityPlayer, position: Vector) {
 }
 
 function dropTaintedForgotten(player: EntityPlayer) {
-  if (isCharacter(player, PlayerType.THE_FORGOTTEN_B)) {
+  if (isCharacter(player, PlayerType.FORGOTTEN_B)) {
     const taintedSoul = player.GetOtherTwin();
     if (taintedSoul !== undefined) {
       taintedSoul.ThrowHeldEntity(VectorZero);

package/src/features/deployJSONRoom.ts

@@ -41,6 +41,7 @@ import {
 } from "../functions/gridEntities";
 import { getRandomJSONEntity, getRandomJSONRoom } from "../functions/jsonRoom";
 import { log } from "../functions/log";
+import { getPlayerFromPtr } from "../functions/players";
 import { getRandomSeed, isRNG, newRNG } from "../functions/rng";
 import { getRoomListIndex } from "../functions/roomData";
 import { gridCoordinatesToWorldPosition } from "../functions/roomGrid";
@@ -134,14 +135,9 @@ function preUseItemWeNeedToGoDeeper(
     removeGridEntity(decoration, false);
   }
 
-  const playerPtr = EntityPtr(player);
+  const entityPtr = EntityPtr(player);
   runNextGameFrame(() => {
-    const futureEntity = playerPtr.Ref;
-    if (futureEntity === undefined) {
-      return;
-    }
-
-    const futurePlayer = futureEntity.ToPlayer();
+    const futurePlayer = getPlayerFromPtr(entityPtr);
     if (futurePlayer === undefined) {
       return;
     }

package/src/features/extraConsoleCommands/listCommands.ts

@@ -5,7 +5,7 @@
 
 /*
 eslint "sort-exports/sort-exports": [
-  "error",
+  "warn",
   {
     sortDir: "asc",
   },

package/src/features/firstLast.ts

@@ -1,10 +1,10 @@
 import {
   CardType,
   CollectibleType,
+  ModCallback,
   PillEffect,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { ModUpgraded } from "../classes/ModUpgraded";
 import { itemConfig } from "../core/cachedClasses";
 import {
   FIRST_CARD_TYPE,
@@ -19,7 +19,6 @@ import {
   NUM_VANILLA_PILL_EFFECTS,
   NUM_VANILLA_TRINKET_TYPES,
 } from "../core/constantsFirstLast";
-import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
 import {
   asCardType,
@@ -35,11 +34,8 @@ const FEATURE_NAME = "firstLast";
 let atLeastOneCallbackFired = false;
 
 /** @internal */
-export function firstLastInit(mod: ModUpgraded): void {
-  mod.AddCallbackCustom(
-    ModCallbackCustom.POST_NEW_ROOM_EARLY,
-    postNewRoomEarly,
-  );
+export function firstLastInit(mod: Mod): void {
+  mod.AddCallback(ModCallback.POST_NEW_ROOM, postNewRoomEarly);
 }
 
 // ModCallbackCustom.POST_NEW_ROOM_EARLY

package/src/features/saveDataManager/constants.ts

@@ -12,7 +12,7 @@ export const SAVE_DATA_MANAGER_FEATURE_NAME = "save data manager";
 export const SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_BACKUP_KEYS = [
   SaveDataKey.RUN,
   SaveDataKey.LEVEL,
-];
+] as const;
 
 export const SAVE_DATA_MANAGER_GLOWING_HOUR_GLASS_IGNORE_KEY =
   "__ignoreGlowingHourGlass";

package/src/features/saveDataManager/exports.ts

@@ -13,6 +13,7 @@ import {
 import {
   saveDataConditionalFuncMap,
   saveDataDefaultsMap,
+  saveDataGlowingHourGlassMap,
   saveDataMap,
 } from "./maps";
 
@@ -252,3 +253,29 @@ export function saveDataManagerReset(
 
   restoreDefaultSaveData(key, saveData, childObjectKey);
 }
+
+/**
+ * Removes a previously registered key from the save data manager. This is the opposite of the
+ * "saveDataManager" function.
+ */
+export function saveDataManagerRemove(key: string): void {
+  errorIfFeaturesNotInitialized(SAVE_DATA_MANAGER_FEATURE_NAME);
+
+  if (!isString(key)) {
+    error(
+      `The ${SAVE_DATA_MANAGER_FEATURE_NAME} requires that keys are strings. You tried to use a key of type: ${typeof key}`,
+    );
+  }
+
+  if (!saveDataMap.has(key)) {
+    error(
+      `The ${SAVE_DATA_MANAGER_FEATURE_NAME} is not managing save data for a key of: ${key}`,
+    );
+  }
+
+  // Delete the save data from the map.
+  saveDataMap.delete(key);
+  saveDataDefaultsMap.delete(key);
+  saveDataConditionalFuncMap.delete(key);
+  saveDataGlowingHourGlassMap.delete(key);
+}

package/src/features/saveDataManager/main.ts

@@ -1,5 +1,4 @@
 import { CollectibleType, ModCallback } from "isaac-typescript-definitions";
-import { ModUpgraded } from "../../classes/ModUpgraded";
 import { game } from "../../core/cachedClasses";
 import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import { SaveDataKey } from "../../enums/SaveDataKey";
@@ -9,6 +8,7 @@ import { logError } from "../../functions/logMisc";
 import { onFirstFloor } from "../../functions/stage";
 import { clearTable, iterateTableInOrder } from "../../functions/table";
 import { SaveData } from "../../interfaces/SaveData";
+import { CallbackTuple } from "../../types/private/CallbackTuple";
 import {
   SAVE_DATA_MANAGER_DEBUG,
   SAVE_DATA_MANAGER_FEATURE_NAME,
@@ -31,36 +31,39 @@ const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey> = new Set([
   SaveDataKey.ROOM,
 ]);
 
-let mod: ModUpgraded | null = null;
+let mod: Mod | null = null;
 let loadedDataOnThisRun = false;
 let restoreGlowingHourGlassDataOnNextRoom = false;
 
-export function saveDataManagerInit(incomingMod: ModUpgraded): void {
-  mod = incomingMod;
-
-  mod.AddCallback(
+export const SAVE_DATA_MANAGER_CALLBACKS: CallbackTuple[] = [
+  [
     ModCallback.POST_USE_ITEM,
-    postUseItemGlowingHourGlass,
-    CollectibleType.GLOWING_HOUR_GLASS,
-  ); // 3
-  mod.AddCallback(ModCallback.POST_PLAYER_INIT, postPlayerInit); // 9
-  mod.AddCallback(ModCallback.PRE_GAME_EXIT, preGameExit); // 17
-  mod.AddCallback(ModCallback.POST_NEW_LEVEL, postNewLevel); // 18
-  mod.AddCallbackCustom(
-    ModCallbackCustom.POST_NEW_ROOM_EARLY,
-    postNewRoomEarly,
-  ); // 19
+    [postUseItemGlowingHourGlass, CollectibleType.GLOWING_HOUR_GLASS],
+  ], // 3
+  [ModCallback.POST_PLAYER_INIT, [postPlayerInit]], // 9
+  [ModCallback.PRE_GAME_EXIT, [preGameExit]], // 17
+  [ModCallback.POST_NEW_LEVEL, [postNewLevel]], // 18
+];
+
+// TODO: add tuple type annotation
+export const SAVE_DATA_MANAGER_CUSTOM_CALLBACKS = [
+  [ModCallbackCustom.POST_NEW_ROOM_EARLY, [postNewRoomEarly]],
+] as const;
+
+export function saveDataManagerInit(incomingMod: Mod): void {
+  mod = incomingMod;
 }
 
 // ModCallback.POST_USE_ITEM (3)
 // CollectibleType.GLOWING_HOUR_GLASS (422)
-function postUseItemGlowingHourGlass() {
+function postUseItemGlowingHourGlass(): boolean | undefined {
   restoreGlowingHourGlassDataOnNextRoom = true;
   return undefined;
 }
 
 // ModCallback.POST_PLAYER_INIT (9)
-function postPlayerInit() {
+// eslint-disable-next-line isaacscript/no-void-return-type
+function postPlayerInit(): void {
   if (mod === null) {
     error(
       `The mod for the ${SAVE_DATA_MANAGER_FEATURE_NAME} was not initialized.`,
@@ -74,6 +77,9 @@ function postPlayerInit() {
   }
   loadedDataOnThisRun = true;
 
+  // Handle the race-condition of using the Glowing Hour Glass and then resetting the run.
+  restoreGlowingHourGlassDataOnNextRoom = false;
+
   // We want to unconditionally load save data on every new run since there might be persistent data
   // that is not tied to an individual run.
   loadFromDisk(mod, saveDataMap);
@@ -89,7 +95,8 @@ function postPlayerInit() {
 }
 
 // ModCallback.PRE_GAME_EXIT (17)
-function preGameExit() {
+// eslint-disable-next-line isaacscript/no-void-return-type
+function preGameExit(): void {
   if (mod === null) {
     error(
       `The mod for the ${SAVE_DATA_MANAGER_FEATURE_NAME} was not initialized.`,
@@ -105,7 +112,8 @@ function preGameExit() {
 }
 
 // ModCallback.POST_NEW_LEVEL (18)
-function postNewLevel() {
+// eslint-disable-next-line isaacscript/no-void-return-type
+function postNewLevel(): void {
   if (mod === null) {
     error(
       `The mod for the ${SAVE_DATA_MANAGER_FEATURE_NAME} was not initialized.`,
@@ -122,7 +130,8 @@ function postNewLevel() {
 }
 
 // ModCallbackCustom.POST_NEW_ROOM_EARLY
-function postNewRoomEarly() {
+// eslint-disable-next-line isaacscript/no-void-return-type
+function postNewRoomEarly(): void {
   restoreDefaults(SaveDataKey.ROOM);
 
   // Handle the Glowing Hour Glass.

package/src/features/saveDataManager/save.ts

@@ -2,7 +2,7 @@ import { SerializationType } from "../../enums/SerializationType";
 import { deepCopy } from "../../functions/deepCopy";
 import { jsonEncode } from "../../functions/jsonHelpers";
 import { log } from "../../functions/log";
-import { iterateTableInOrder } from "../../functions/table";
+import { isTableEmpty, iterateTableInOrder } from "../../functions/table";
 import { SaveData } from "../../interfaces/SaveData";
 import {
   SAVE_DATA_MANAGER_DEBUG,
@@ -53,7 +53,7 @@ function getAllSaveDataToWriteToDisk(
       };
 
       // If there is no data, then we can move on to the next feature.
-      if (Object.keys(saveDataWithoutRoom).length === 0) {
+      if (isTableEmpty(saveDataWithoutRoom as LuaTable<AnyNotNil, unknown>)) {
         return;
       }
 

package/src/features.ts

@@ -0,0 +1,90 @@
+import { ModCallbackCustomToClass } from "./callbacks";
+import { CustomGridEntities } from "./classes/features/callbackLogic/CustomGridEntities";
+import { CustomRevive } from "./classes/features/callbackLogic/CustomRevive";
+import { EsauJrDetection } from "./classes/features/callbackLogic/EsauJrDetection";
+import { FlipDetection } from "./classes/features/callbackLogic/FlipDetection";
+import { GameReorderedCallbacks } from "./classes/features/callbackLogic/GameReorderedCallbacks";
+import { GridEntityCollisionDetection } from "./classes/features/callbackLogic/GridEntityCollisionDetection";
+import { GridEntityDetection } from "./classes/features/callbackLogic/GridEntityDetection";
+import { PlayerReorderedCallbacks } from "./classes/features/callbackLogic/PlayerReorderedCallbacks";
+import { RunInNFrames } from "./classes/features/other/RunInNFrames";
+import { ISCFeature } from "./enums/ISCFeature";
+import { ModCallbackCustom2 } from "./enums/ModCallbackCustom2";
+import {
+  newObjectWithEnumKeys,
+  validateInterfaceMatchesEnum,
+} from "./functions/utils";
+
+export interface ISCFeatureToClass {
+  // Callback logic
+  [ISCFeature.CUSTOM_REVIVE]: CustomRevive;
+  [ISCFeature.ESAU_JR_DETECTION]: EsauJrDetection;
+  [ISCFeature.FLIP_DETECTION]: FlipDetection;
+  [ISCFeature.GRID_ENTITY_COLLISION_DETECTION]: GridEntityCollisionDetection;
+  [ISCFeature.GRID_ENTITY_DETECTION]: GridEntityDetection;
+  [ISCFeature.GAME_REORDERED_CALLBACKS]: GameReorderedCallbacks;
+  [ISCFeature.PLAYER_REORDERED_CALLBACKS]: PlayerReorderedCallbacks;
+
+  // Extra features
+  [ISCFeature.CUSTOM_GRID_ENTITIES]: CustomGridEntities;
+  [ISCFeature.RUN_IN_N_FRAMES]: RunInNFrames;
+}
+
+validateInterfaceMatchesEnum<ISCFeatureToClass, ISCFeature>();
+
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export function getFeatures(callbacks: ModCallbackCustomToClass) {
+  // Some features rely on other features; we must initialize those first.
+  const runInNFrames = new RunInNFrames();
+  const customGridEntities = new CustomGridEntities(runInNFrames);
+
+  return newObjectWithEnumKeys(ISCFeature, {
+    // Callback logic
+    [ISCFeature.CUSTOM_REVIVE]: new CustomRevive(
+      callbacks[ModCallbackCustom2.PRE_CUSTOM_REVIVE],
+      callbacks[ModCallbackCustom2.POST_CUSTOM_REVIVE],
+    ),
+    [ISCFeature.ESAU_JR_DETECTION]: new EsauJrDetection(
+      callbacks[ModCallbackCustom2.POST_ESAU_JR],
+      callbacks[ModCallbackCustom2.POST_FIRST_ESAU_JR],
+    ),
+    [ISCFeature.FLIP_DETECTION]: new FlipDetection(
+      callbacks[ModCallbackCustom2.POST_FLIP],
+      callbacks[ModCallbackCustom2.POST_FIRST_FLIP],
+    ),
+    [ISCFeature.GRID_ENTITY_COLLISION_DETECTION]:
+      new GridEntityCollisionDetection(
+        callbacks[ModCallbackCustom2.POST_GRID_ENTITY_COLLISION],
+        callbacks[ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_COLLISION],
+        customGridEntities,
+      ),
+    [ISCFeature.GRID_ENTITY_DETECTION]: new GridEntityDetection(
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_INIT],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_INIT],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_UPDATE],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_UPDATE],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_REMOVE],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_REMOVE],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_STATE_CHANGED],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_STATE_CHANGED],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_BROKEN],
+      callbacks[ModCallbackCustom2.POST_GRID_ENTITY_CUSTOM_BROKEN],
+      customGridEntities,
+    ),
+    [ISCFeature.GAME_REORDERED_CALLBACKS]: new GameReorderedCallbacks(
+      callbacks[ModCallbackCustom2.POST_GAME_STARTED_REORDERED],
+      callbacks[ModCallbackCustom2.POST_NEW_LEVEL_REORDERED],
+      callbacks[ModCallbackCustom2.POST_NEW_ROOM_REORDERED],
+      callbacks[ModCallbackCustom2.POST_GAME_STARTED_REORDERED_LAST],
+    ),
+    [ISCFeature.PLAYER_REORDERED_CALLBACKS]: new PlayerReorderedCallbacks(
+      callbacks[ModCallbackCustom2.POST_PEFFECT_UPDATE_REORDERED],
+      callbacks[ModCallbackCustom2.POST_PLAYER_RENDER_REORDERED],
+      callbacks[ModCallbackCustom2.POST_PEFFECT_UPDATE_REORDERED],
+    ),
+
+    // Extra features
+    [ISCFeature.CUSTOM_GRID_ENTITIES]: customGridEntities,
+    [ISCFeature.RUN_IN_N_FRAMES]: runInNFrames,
+  } as const);
+}

package/src/functions/ambush.ts

@@ -1,4 +1,6 @@
-import { SackSubType } from "isaac-typescript-definitions";
+import { RoomType, SackSubType } from "isaac-typescript-definitions";
+import { game } from "../core/cachedClasses";
+import { AmbushType } from "../enums/AmbushType";
 import { runNextGameFrame } from "../features/runInNFrames";
 import { removeEntities } from "./entities";
 import { getCoins, spawnSackWithSeed } from "./pickupsSpecific";
@@ -6,6 +8,29 @@ import { getCoins, spawnSackWithSeed } from "./pickupsSpecific";
 /** Hard-coding this makes it easier to clean up the pickups afterwards. */
 const SACK_SEED_THAT_SPAWNS_TWO_COINS = 6 as Seed;
 
+/**
+ * Helper function to get the corresponding ambush type for the current room. Returns undefined if
+ * the current room does not correspond to any particular ambush type.
+ */
+export function getAmbushType(): AmbushType | undefined {
+  const room = game.GetRoom();
+  const roomType = room.GetType();
+
+  switch (roomType) {
+    case RoomType.BOSS_RUSH: {
+      return AmbushType.BOSS_RUSH;
+    }
+
+    case RoomType.CHALLENGE: {
+      return AmbushType.CHALLENGE_ROOM;
+    }
+
+    default: {
+      return undefined;
+    }
+  }
+}
+
 /**
  * Helper function to start a Challenge Room or the Boss Rush.
  *

package/src/functions/characters.ts

@@ -79,7 +79,7 @@ export function getCharacterDeathAnimationName(character: PlayerType): string {
     return "LostDeath";
   }
 
-  if (character === PlayerType.THE_FORGOTTEN_B) {
+  if (character === PlayerType.FORGOTTEN_B) {
     return "ForgottenDeath";
   }
 
@@ -98,12 +98,12 @@ export function getCharacterMaxHeartContainers(character: PlayerType): int {
   }
 
   // 16
-  if (character === PlayerType.THE_FORGOTTEN) {
+  if (character === PlayerType.FORGOTTEN) {
     return 6;
   }
 
   // 17
-  if (character === PlayerType.THE_SOUL) {
+  if (character === PlayerType.SOUL) {
     return 6;
   }