isaacscript-common 13.3.4 → 14.0.0

package/src/core/upgradeMod.ts

@@ -1,6 +1,10 @@
 import { postNewRoomEarlyCallbackInit } from "../callbacks/postNewRoomEarly";
 import { ModUpgraded } from "../classes/ModUpgraded";
-import { saveDataManagerInit } from "../features/saveDataManager/main";
+import {
+  saveDataManagerInit,
+  SAVE_DATA_MANAGER_CALLBACKS,
+  SAVE_DATA_MANAGER_CUSTOM_CALLBACKS,
+} from "../features/saveDataManager/main";
 import {
   areFeaturesInitialized,
   setFeaturesInitialized,
@@ -53,8 +57,18 @@ export function upgradeMod(
     postNewRoomEarlyCallbackInit(mod);
 
     // We initialized the save data manager second since it is used by the other custom callbacks
-    // and features.
+    // and features. We can't pass the instantiated `ModUpgraded` class to the "saveDataManagerInit"
+    // function since it causes a circular dependency. Thus, we emulate the initialization process
+    // that the `ModUpgraded.AddCallbackCustom` method uses.
     saveDataManagerInit(mod);
+    for (const callbackTuple of SAVE_DATA_MANAGER_CALLBACKS) {
+      const [modCallback, callbackArgs] = callbackTuple;
+      mod.AddCallback(modCallback, ...callbackArgs);
+    }
+    for (const callbackTuple of SAVE_DATA_MANAGER_CUSTOM_CALLBACKS) {
+      const [modCallback, callbackArgs] = callbackTuple;
+      mod.AddCallbackCustom(modCallback, ...callbackArgs);
+    }
 
     // We initialize custom callbacks next since some features use custom callbacks.
     initCustomCallbacks(mod);

package/src/enums/IsaacScriptCommonFeature.ts

@@ -0,0 +1,34 @@
+export enum IsaacScriptCommonFeature {
+  CHARACTER_HEALTH_CONVERSION = "characterHealthConversion",
+  CHARACTER_STATS = "characterStats",
+  COLLECTIBLE_ITEM_POOL_TYPE = "collectibleItemPoolType",
+  CUSTOM_GRID_ENTITY = "customGridEntity",
+  CUSTOM_HOTKEYS = "customHotkeys",
+  CUSTOM_PICKUP = "customPickup",
+  CUSTOM_STAGE = "customStage",
+  CUSTOM_TRAPDOOR = "customTrapdoor",
+  DEBUG_DISPLAY = "debugDisplay",
+  DEPLOY_JSON_ROOM = "deployJSONRoom",
+  DISABLE_ALL_SOUND = "displayAllSound",
+  DISABLE_INPUTS = "disableInputs",
+  FADE_IN_REMOVER = "fadeInRemover",
+  FAST_RESET = "fastReset",
+  FIRST_LAST = "firstLast",
+  FORGOTTEN_SWITCH = "forgottenSwitch",
+  EXTRA_CONSOLE_COMMANDS = "extraConsoleCommands",
+  PAUSE = "pause",
+  PERSISTENT_ENTITIES = "persistentEntities",
+  PICKUP_INDEX = "pickupIndex",
+  PLAYER_INVENTORY = "playerInventory",
+  PONY_DETECTION = "ponyDetection",
+  PREVENT_CHILD_ENTITIES = "preventChildEntities",
+  PREVENT_COLLECTIBLE_ROTATION = "preventCollectibleRotation",
+  ROOM_CLEAR_FRAME = "roomClearFrame",
+  ROOM_HISTORY = "roomHistory",
+  RUN_IN_N_FRAMES = "runInNFrames",
+  RUN_NEXT_ROOM = "runNextRoom",
+  SAVE_DATA_MANAGER = "saveDataManager",
+  SIREN_HELPERS = "sirenHelpers",
+  STAGE_HISTORY = "stageHistory",
+  TAINTED_LAZARUS_PLAYERS = "taintedLazarusPlayers",
+}

package/src/enums/LadderSubTypeCustom.ts

@@ -0,0 +1,17 @@
+/**
+ * For `EntityType.EFFECT` (1000), `EffectVariant.LADDER` (8).
+ *
+ * Note that vanilla ladders only use a sub-type of 0. The `isaacscript-common` library uses ladders
+ * to represent custom objects, since they are non-interacting and will not automatically despawn
+ * after time passes, unlike most other effects.
+ *
+ * This enum tracks the kinds of custom objects that are represented by vanilla ladders. We start
+ * assigning sub-types after 100 as to not interfere with any possible modded ladder variants.
+ */
+export enum LadderSubTypeCustom {
+  LADDER = 0,
+
+  CUSTOM_BACKDROP = 101,
+  CUSTOM_SHADOW = 102,
+  CUSTOM_PICKUP = 103,
+}