isaacscript-common 20.11.6 → 20.12.1

package/dist/index.d.ts

@@ -6948,6 +6948,9 @@ export declare function initArray<T>(defaultValue: T, size: int): T[];
  * Helper function to instantiate an array of mod features all at once. Use this function if your
  * mod uses the pattern of expressing mod features as `ModFeature` classes.
  *
+ * If your feature classes have `v` variables, then this function will successfully register them
+ * with the save data manager.
+ *
  * For example:
  *
  * ```ts
@@ -8406,7 +8409,14 @@ export declare function lockDoor(door: GridEntityDoor): void;
  * Helper function to avoid typing out `Isaac.DebugString()`.
  *
  * If you have the "--luadebug" launch flag turned on or the Racing+ sandbox enabled, then this
- * function will also prepend the function name and the line number before the string.
+ * function will also prepend the function name and the line number before the string, like this:
+ *
+ * ```text
+ * [INFO] - Lua Debug: saveToDisk:42494 - The save data manager wrote data to the "save#.dat" file.
+ * ```
+ *
+ * Subsequently, it is recommended that you turn on the "--luadebug" launch flag when developing
+ * your mod so that debugging becomes a little bit easier.
  */
 export declare function log(msg: string): void;
 
@@ -11434,6 +11444,14 @@ declare class ModdedElementSets extends Feature {
  * In almost all cases, you will want the callback functions to be immediately subscribed after
  * instantiating the class. However, if this is not the case, you can pass `false` as the optional
  * second argument to the constructor.
+ *
+ * If your mod feature has a property called `v`, it will be assumed that these are variables that
+ * should be managed by the save data manager. Subsequently, they will automatically be registered
+ * with the save data manager upon initialization. Unfortunately, due to technical limitations with
+ * classes, this registration will only occur if you initialize the class with the `init` boolean
+ * argument set to false, and then explicitly call the `ModFeature.init` method yourself after the
+ * class is constructed. (This is because the parent class does not have access to the child's
+ * properties upon first construction.)
  */
 export declare class ModFeature {
     private mod;
@@ -15100,7 +15118,8 @@ export declare interface TrinketSituation {
 }
 
 /**
- * This is a type representing a user-created class from TypeScript code.
+ * This is a type representing a user-created class from TypeScript code. (TypeScriptToLua
+ * transpiles TypeScript classes to a Lua table with a specific kind of metatable.)
  *
  * This type is used by the save data manager to when copying, serializing, and deserializing.
  */
@@ -15108,6 +15127,10 @@ export declare type TSTLClass = LuaMap<AnyNotNil, unknown> & {
     readonly __tstlClassBrand: symbol;
 };
 
+/**
+ * This is a type representing the metatable of a user-created class from TypeScript code.
+ * (TypeScriptToLua transpiles TypeScript classes to a Lua table with a specific kind of metatable.)
+ */
 declare interface TSTLClassMetatable {
     ____constructor: () => void;
     __index: unknown;

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 20.11.6
+isaacscript-common 20.12.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -14516,7 +14516,7 @@ ____exports.RockVariant.NORMAL = 0
 ____exports.RockVariant[____exports.RockVariant.NORMAL] = "NORMAL"
 ____exports.RockVariant.EVENT = 1
 ____exports.RockVariant[____exports.RockVariant.EVENT] = "EVENT"
---- For GridEntityType.ROCK_ALT (6), RockAltType.URN
+--- For GridEntityType.ROCK_ALT (6), RockAltType.URN.
 -- 
 -- Note that you are unable to spawn specific urn variants. The game will pick a random variant
 -- regardless of which one you select.
@@ -14527,7 +14527,7 @@ ____exports.UrnVariant.CHIPPED_TOP_LEFT = 1
 ____exports.UrnVariant[____exports.UrnVariant.CHIPPED_TOP_LEFT] = "CHIPPED_TOP_LEFT"
 ____exports.UrnVariant.NARROW = 2
 ____exports.UrnVariant[____exports.UrnVariant.NARROW] = "NARROW"
---- For GridEntityType.ROCK_ALT (6), RockAltType.MUSHROOM
+--- For GridEntityType.ROCK_ALT (6), RockAltType.MUSHROOM.
 -- 
 -- Note that you are unable to spawn specific mushroom variants. The game will pick a random variant
 -- regardless of which one you select.
@@ -14538,7 +14538,7 @@ ____exports.MushroomVariant.CHIPPED_TOP_RIGHT = 1
 ____exports.MushroomVariant[____exports.MushroomVariant.CHIPPED_TOP_RIGHT] = "CHIPPED_TOP_RIGHT"
 ____exports.MushroomVariant.NARROW = 2
 ____exports.MushroomVariant[____exports.MushroomVariant.NARROW] = "NARROW"
---- For GridEntityType.ROCK_ALT (6), RockAltType.SKULL
+--- For GridEntityType.ROCK_ALT (6), RockAltType.SKULL.
 -- 
 -- Note that you are unable to spawn specific skull variants. The game will pick a random variant
 -- regardless of which one you select.
@@ -14549,7 +14549,7 @@ ____exports.SkullVariant.FACING_RIGHT = 1
 ____exports.SkullVariant[____exports.SkullVariant.FACING_RIGHT] = "FACING_RIGHT"
 ____exports.SkullVariant.FACING_LEFT = 2
 ____exports.SkullVariant[____exports.SkullVariant.FACING_LEFT] = "FACING_LEFT"
---- For GridEntityType.ROCK_ALT (6), RockAltType.POLYP
+--- For GridEntityType.ROCK_ALT (6), RockAltType.POLYP.
 -- 
 -- Note that you are unable to spawn specific polyp variants. The game will pick a random variant
 -- regardless of which one you select.
@@ -14560,7 +14560,7 @@ ____exports.PolypVariant.MANY_FINGERS = 1
 ____exports.PolypVariant[____exports.PolypVariant.MANY_FINGERS] = "MANY_FINGERS"
 ____exports.PolypVariant.FLIPPED_AND_SHIFTED_UPWARDS = 2
 ____exports.PolypVariant[____exports.PolypVariant.FLIPPED_AND_SHIFTED_UPWARDS] = "FLIPPED_AND_SHIFTED_UPWARDS"
---- For GridEntityType.ROCK_ALT (6), RockAltType.BUCKET
+--- For GridEntityType.ROCK_ALT (6), RockAltType.BUCKET.
 -- 
 -- Note that you are unable to spawn specific bucket variants. The game will pick a random variant
 -- regardless of which one you select.
@@ -14577,7 +14577,7 @@ ____exports.PitVariant.NORMAL = 0
 ____exports.PitVariant[____exports.PitVariant.NORMAL] = "NORMAL"
 ____exports.PitVariant.FISSURE_SPAWNER = 16
 ____exports.PitVariant[____exports.PitVariant.FISSURE_SPAWNER] = "FISSURE_SPAWNER"
---- For `GridEntityType.FIREPLACE`. (13).
+--- For `GridEntityType.FIREPLACE` (13).
 -- 
 -- This only partially corresponds to the `FireplaceVariant` for non-grid entities. (Spawning a grid
 -- entity fireplace with a variant higher than 1 will result in a normal fireplace.)
@@ -14586,7 +14586,7 @@ ____exports.FireplaceGridEntityVariant.NORMAL = 0
 ____exports.FireplaceGridEntityVariant[____exports.FireplaceGridEntityVariant.NORMAL] = "NORMAL"
 ____exports.FireplaceGridEntityVariant.RED = 1
 ____exports.FireplaceGridEntityVariant[____exports.FireplaceGridEntityVariant.RED] = "RED"
---- For `GridEntityType.POOP`. (14).
+--- For `GridEntityType.POOP` (14).
 ____exports.PoopGridEntityVariant = {}
 ____exports.PoopGridEntityVariant.NORMAL = 0
 ____exports.PoopGridEntityVariant[____exports.PoopGridEntityVariant.NORMAL] = "NORMAL"
@@ -14612,7 +14612,7 @@ ____exports.PoopGridEntityVariant.GIGA_BOTTOM_RIGHT = 10
 ____exports.PoopGridEntityVariant[____exports.PoopGridEntityVariant.GIGA_BOTTOM_RIGHT] = "GIGA_BOTTOM_RIGHT"
 ____exports.PoopGridEntityVariant.CHARMING = 11
 ____exports.PoopGridEntityVariant[____exports.PoopGridEntityVariant.CHARMING] = "CHARMING"
---- For `GridEntityType.DOOR`. (16).
+--- For `GridEntityType.DOOR` (16).
 ____exports.DoorVariant = {}
 ____exports.DoorVariant.UNSPECIFIED = 0
 ____exports.DoorVariant[____exports.DoorVariant.UNSPECIFIED] = "UNSPECIFIED"
@@ -14638,7 +14638,7 @@ ____exports.TrapdoorVariant.NORMAL = 0
 ____exports.TrapdoorVariant[____exports.TrapdoorVariant.NORMAL] = "NORMAL"
 ____exports.TrapdoorVariant.VOID_PORTAL = 1
 ____exports.TrapdoorVariant[____exports.TrapdoorVariant.VOID_PORTAL] = "VOID_PORTAL"
---- For `GridEntityType.CRAWL_SPACE`. (18).
+--- For `GridEntityType.CRAWL_SPACE` (18).
 ____exports.CrawlSpaceVariant = {}
 ____exports.CrawlSpaceVariant.NORMAL = 0
 ____exports.CrawlSpaceVariant[____exports.CrawlSpaceVariant.NORMAL] = "NORMAL"
@@ -49900,7 +49900,7 @@ local __TS__Class = ____lualib.__TS__Class
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local initDecoratedCallbacks, addCallback, removeCallback, WRAPPED_CALLBACK_METHODS_KEY, WRAPPED_CUSTOM_CALLBACK_METHODS_KEY
+local initDecoratedCallbacks, addCallback, removeCallback, initSaveDataManager, WRAPPED_CALLBACK_METHODS_KEY, WRAPPED_CUSTOM_CALLBACK_METHODS_KEY
 local ____array = require("src.functions.array")
 local isArray = ____array.isArray
 local ____tstlClass = require("src.functions.tstlClass")
@@ -49909,6 +49909,7 @@ local getTSTLClassName = ____tstlClass.getTSTLClassName
 local ____types = require("src.functions.types")
 local isFunction = ____types.isFunction
 local isNumber = ____types.isNumber
+local isTable = ____types.isTable
 function initDecoratedCallbacks(self, modFeature, constructor, tstlClassName, vanilla, init)
     local modFeatureConstructor = constructor
     local callbackTuplesKey = vanilla and ____exports.MOD_FEATURE_CALLBACKS_KEY or ____exports.MOD_FEATURE_CUSTOM_CALLBACKS_KEY
@@ -50020,6 +50021,34 @@ function removeCallback(self, modFeatureConstructor, mod, modCallback, vanilla)
         mod:RemoveCallbackCustom(modCallback, wrappedCallback)
     end
 end
+function initSaveDataManager(self, modFeature, tstlClassName, init)
+    if tstlClassName == "AtePoopBaby" then
+        Isaac.DebugString("GETTING HERE 1")
+    end
+    local ____modFeature_0 = modFeature
+    local v = ____modFeature_0.v
+    if v == nil then
+        return
+    end
+    Isaac.DebugString("GETTING HERE 2")
+    if not isTable(nil, v) then
+        error("Failed to initialize a mod feature class due to having a \"v\" property that is not an object. (The \"v\" property is supposed to be an object that holds the variables for the class, managed by the save data manager.)")
+    end
+    local mod = modFeature.mod
+    local saveDataManagerMethodName = init and "saveDataManager" or "saveDataManagerRemove"
+    local saveDataManagerMethod = mod[saveDataManagerMethodName]
+    if saveDataManagerMethod == nil then
+        error("Failed to initialize a mod feature class due to having a \"v\" object and not having the save data manager initialized. You must pass \"ISCFeature.SAVE_DATA_MANAGER\" to the \"upgradeMod\" function.")
+    end
+    if type(saveDataManagerMethod) ~= "function" then
+        error(("The \"" .. saveDataManagerMethodName) .. "\" property of the \"ModUpgraded\" object was not a function.")
+    end
+    if init then
+        saveDataManagerMethod(nil, tstlClassName, v)
+    else
+        saveDataManagerMethod(nil, tstlClassName)
+    end
+end
 ____exports.MOD_FEATURE_CALLBACKS_KEY = "__callbacks"
 ____exports.MOD_FEATURE_CUSTOM_CALLBACKS_KEY = "__customCallbacks"
 WRAPPED_CALLBACK_METHODS_KEY = "__wrappedCallbackMethods"
@@ -50070,6 +50099,7 @@ function ModFeature.prototype.init(self, init)
         false,
         init
     )
+    initSaveDataManager(nil, self, tstlClassName, init)
 end
 function ModFeature.prototype.uninit(self)
     self:init(false)
@@ -51003,7 +51033,8 @@ local ____exports = {}
 function ____exports.initModFeatures(self, mod, modFeatures)
     local instantiatedModFeatures = {}
     for ____, modFeature in ipairs(modFeatures) do
-        local instantiatedModFeature = __TS__New(modFeature, mod)
+        local instantiatedModFeature = __TS__New(modFeature, mod, false)
+        instantiatedModFeature:init()
         instantiatedModFeatures[#instantiatedModFeatures + 1] = instantiatedModFeature
     end
     return instantiatedModFeatures

package/dist/src/classes/ModFeature.d.ts

@@ -18,6 +18,14 @@ export declare const MOD_FEATURE_CUSTOM_CALLBACKS_KEY = "__customCallbacks";
  * In almost all cases, you will want the callback functions to be immediately subscribed after
  * instantiating the class. However, if this is not the case, you can pass `false` as the optional
  * second argument to the constructor.
+ *
+ * If your mod feature has a property called `v`, it will be assumed that these are variables that
+ * should be managed by the save data manager. Subsequently, they will automatically be registered
+ * with the save data manager upon initialization. Unfortunately, due to technical limitations with
+ * classes, this registration will only occur if you initialize the class with the `init` boolean
+ * argument set to false, and then explicitly call the `ModFeature.init` method yourself after the
+ * class is constructed. (This is because the parent class does not have access to the child's
+ * properties upon first construction.)
  */
 export declare class ModFeature {
     private mod;

package/dist/src/classes/ModFeature.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAS/D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AACvD,eAAO,MAAM,gCAAgC,sBAAsB,CAAC;AAyBpE;;;;;;;;;;;;;;;GAeG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CAAC,yBAAyB,EAC/B,CAAC,CAAC,CAAC,SAAS,OAAO,EACjB,OAAO,EAAE,CAAC,EACV,WAAW,EAAE,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,iBAAiB,EAC7D,GAAG,YAAY,EAAE,OAAO,EAAE,KACvB,OAAO,CAAC,GACb,IAAI,CAAQ;IAEhB;;;;;OAKG;IACI,WAAW,UAAS;gBAEf,GAAG,EAAE,eAAe,EAAE,IAAI,UAAO;IAQ7C;;;;;OAKG;IACI,IAAI,CAAC,IAAI,UAAO,GAAG,IAAI;IAoB9B;;;;;OAKG;IACI,MAAM,IAAI,IAAI;CAGtB"}
+{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAS/D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AACvD,eAAO,MAAM,gCAAgC,sBAAsB,CAAC;AAyBpE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CAAC,yBAAyB,EAC/B,CAAC,CAAC,CAAC,SAAS,OAAO,EACjB,OAAO,EAAE,CAAC,EACV,WAAW,EAAE,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,iBAAiB,EAC7D,GAAG,YAAY,EAAE,OAAO,EAAE,KACvB,OAAO,CAAC,GACb,IAAI,CAAQ;IAEhB;;;;;OAKG;IACI,WAAW,UAAS;gBAEf,GAAG,EAAE,eAAe,EAAE,IAAI,UAAO;IAQ7C;;;;;OAKG;IACI,IAAI,CAAC,IAAI,UAAO,GAAG,IAAI;IAqB9B;;;;;OAKG;IACI,MAAM,IAAI,IAAI;CAGtB"}

package/dist/src/classes/ModFeature.lua

@@ -3,7 +3,7 @@ local __TS__Class = ____lualib.__TS__Class
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local initDecoratedCallbacks, addCallback, removeCallback, WRAPPED_CALLBACK_METHODS_KEY, WRAPPED_CUSTOM_CALLBACK_METHODS_KEY
+local initDecoratedCallbacks, addCallback, removeCallback, initSaveDataManager, WRAPPED_CALLBACK_METHODS_KEY, WRAPPED_CUSTOM_CALLBACK_METHODS_KEY
 local ____array = require("src.functions.array")
 local isArray = ____array.isArray
 local ____tstlClass = require("src.functions.tstlClass")
@@ -12,6 +12,7 @@ local getTSTLClassName = ____tstlClass.getTSTLClassName
 local ____types = require("src.functions.types")
 local isFunction = ____types.isFunction
 local isNumber = ____types.isNumber
+local isTable = ____types.isTable
 function initDecoratedCallbacks(self, modFeature, constructor, tstlClassName, vanilla, init)
     local modFeatureConstructor = constructor
     local callbackTuplesKey = vanilla and ____exports.MOD_FEATURE_CALLBACKS_KEY or ____exports.MOD_FEATURE_CUSTOM_CALLBACKS_KEY
@@ -123,6 +124,34 @@ function removeCallback(self, modFeatureConstructor, mod, modCallback, vanilla)
         mod:RemoveCallbackCustom(modCallback, wrappedCallback)
     end
 end
+function initSaveDataManager(self, modFeature, tstlClassName, init)
+    if tstlClassName == "AtePoopBaby" then
+        Isaac.DebugString("GETTING HERE 1")
+    end
+    local ____modFeature_0 = modFeature
+    local v = ____modFeature_0.v
+    if v == nil then
+        return
+    end
+    Isaac.DebugString("GETTING HERE 2")
+    if not isTable(nil, v) then
+        error("Failed to initialize a mod feature class due to having a \"v\" property that is not an object. (The \"v\" property is supposed to be an object that holds the variables for the class, managed by the save data manager.)")
+    end
+    local mod = modFeature.mod
+    local saveDataManagerMethodName = init and "saveDataManager" or "saveDataManagerRemove"
+    local saveDataManagerMethod = mod[saveDataManagerMethodName]
+    if saveDataManagerMethod == nil then
+        error("Failed to initialize a mod feature class due to having a \"v\" object and not having the save data manager initialized. You must pass \"ISCFeature.SAVE_DATA_MANAGER\" to the \"upgradeMod\" function.")
+    end
+    if type(saveDataManagerMethod) ~= "function" then
+        error(("The \"" .. saveDataManagerMethodName) .. "\" property of the \"ModUpgraded\" object was not a function.")
+    end
+    if init then
+        saveDataManagerMethod(nil, tstlClassName, v)
+    else
+        saveDataManagerMethod(nil, tstlClassName)
+    end
+end
 ____exports.MOD_FEATURE_CALLBACKS_KEY = "__callbacks"
 ____exports.MOD_FEATURE_CUSTOM_CALLBACKS_KEY = "__customCallbacks"
 WRAPPED_CALLBACK_METHODS_KEY = "__wrappedCallbackMethods"
@@ -141,6 +170,14 @@ WRAPPED_CUSTOM_CALLBACK_METHODS_KEY = "__wrappedCustomCallbacksMethods"
 -- In almost all cases, you will want the callback functions to be immediately subscribed after
 -- instantiating the class. However, if this is not the case, you can pass `false` as the optional
 -- second argument to the constructor.
+-- 
+-- If your mod feature has a property called `v`, it will be assumed that these are variables that
+-- should be managed by the save data manager. Subsequently, they will automatically be registered
+-- with the save data manager upon initialization. Unfortunately, due to technical limitations with
+-- classes, this registration will only occur if you initialize the class with the `init` boolean
+-- argument set to false, and then explicitly call the `ModFeature.init` method yourself after the
+-- class is constructed. (This is because the parent class does not have access to the child's
+-- properties upon first construction.)
 ____exports.ModFeature = __TS__Class()
 local ModFeature = ____exports.ModFeature
 ModFeature.name = "ModFeature"
@@ -187,6 +224,7 @@ function ModFeature.prototype.init(self, init)
         false,
         init
     )
+    initSaveDataManager(nil, self, tstlClassName, init)
 end
 function ModFeature.prototype.uninit(self)
     self:init(false)

package/dist/src/classes/features/other/CustomTrapdoors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomTrapdoors.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomTrapdoors.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,UAAU,EAKV,SAAS,EACV,MAAM,8BAA8B,CAAC;AA6BtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAgChD,qBAAa,eAAgB,SAAQ,OAAO;IAC1C,qCAAqC;IACrC,OAAO,CAAC,kBAAkB,CAOtB;IAqBJ;;;;;OAKG;IACH,OAAO,CAAC,WAAW,CAAY;IAE/B,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,YAAY,CAAe;IAmDnC,OAAO,CAAC,UAAU,CAMhB;IAEF,OAAO,CAAC,2BAA2B;IA+BnC,OAAO,CAAC,8BAA8B;IAmDtC,OAAO,CAAC,6BAA6B;IAsBrC,OAAO,CAAC,kBAAkB;IAqB1B,OAAO,CAAC,4BAA4B;IA+CpC,OAAO,CAAC,iCAAiC;IAsBzC,OAAO,CAAC,eAAe;IAqBvB,OAAO,CAAC,kCAAkC,CAaxC;IAEF,OAAO,CAAC,4BAA4B;IAcpC,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,sBAAsB;IAmB9B,OAAO,CAAC,gCAAgC;IAuCxC,OAAO,CAAC,2BAA2B;IAqCnC,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,8BAA8B;IAmDtC,OAAO,CAAC,0BAA0B,CAEhC;IAEF,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,uBAAuB;IA4B/B,OAAO,CAAC,eAAe;IAUvB;;;;;;;;;;;;;;;;;;OAkBG;IAEI,iCAAiC,CACtC,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,CACf,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,gBAAgB,EAAE,UAAU,EAC5B,oBAAoB,EAAE,SAAS,KAC5B,IAAI,GACR,IAAI;IAUP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEI,mBAAmB,CACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,eAAe,CAAC,EAAE,MAAM,EACxB,gBAAgB,CAAC,EAAE,UAAU,EAC7B,oBAAoB,CAAC,EAAE,SAAS,EAChC,QAAQ,SAAmC,EAC3C,SAAS,CAAC,EAAE,OAAO,GAClB,UAAU;CA0Dd"}
+{"version":3,"file":"CustomTrapdoors.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/CustomTrapdoors.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,UAAU,EAKV,SAAS,EACV,MAAM,8BAA8B,CAAC;AA6BtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAgChD,qBAAa,eAAgB,SAAQ,OAAO;IAC1C,qCAAqC;IACrC,OAAO,CAAC,kBAAkB,CAOtB;IAqBJ;;;;;OAKG;IACH,OAAO,CAAC,WAAW,CAAY;IAE/B,OAAO,CAAC,kBAAkB,CAAqB;IAC/C,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,YAAY,CAAe;IAmDnC,OAAO,CAAC,UAAU,CAMhB;IAEF,OAAO,CAAC,2BAA2B;IA+BnC,OAAO,CAAC,8BAA8B;IAmDtC,OAAO,CAAC,6BAA6B;IAsBrC,OAAO,CAAC,kBAAkB;IAqB1B,OAAO,CAAC,4BAA4B;IAiDpC,OAAO,CAAC,iCAAiC;IAsBzC,OAAO,CAAC,eAAe;IAqBvB,OAAO,CAAC,kCAAkC,CAaxC;IAEF,OAAO,CAAC,4BAA4B;IAcpC,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,sBAAsB;IAmB9B,OAAO,CAAC,gCAAgC;IAuCxC,OAAO,CAAC,2BAA2B;IAqCnC,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,8BAA8B;IAmDtC,OAAO,CAAC,0BAA0B,CAEhC;IAEF,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,uBAAuB;IA4B/B,OAAO,CAAC,eAAe;IAUvB;;;;;;;;;;;;;;;;;;OAkBG;IAEI,iCAAiC,CACtC,eAAe,EAAE,MAAM,EACvB,eAAe,EAAE,CACf,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,gBAAgB,EAAE,UAAU,EAC5B,oBAAoB,EAAE,SAAS,KAC5B,IAAI,GACR,IAAI;IAUP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEI,mBAAmB,CACxB,mBAAmB,EAAE,GAAG,GAAG,MAAM,EACjC,eAAe,CAAC,EAAE,MAAM,EACxB,gBAAgB,CAAC,EAAE,UAAU,EAC7B,oBAAoB,CAAC,EAAE,SAAS,EAChC,QAAQ,SAAmC,EAC3C,SAAS,CAAC,EAAE,OAAO,GAClB,UAAU;CA0Dd"}

package/dist/src/functions/log.d.ts

@@ -13,7 +13,14 @@ export declare function getParentFunctionDescription(levels?: number): string |
  * Helper function to avoid typing out `Isaac.DebugString()`.
  *
  * If you have the "--luadebug" launch flag turned on or the Racing+ sandbox enabled, then this
- * function will also prepend the function name and the line number before the string.
+ * function will also prepend the function name and the line number before the string, like this:
+ *
+ * ```text
+ * [INFO] - Lua Debug: saveToDisk:42494 - The save data manager wrote data to the "save#.dat" file.
+ * ```
+ *
+ * Subsequently, it is recommended that you turn on the "--luadebug" launch flag when developing
+ * your mod so that debugging becomes a little bit easier.
  */
 export declare function log(msg: string): void;
 //# sourceMappingURL=log.d.ts.map

package/dist/src/functions/log.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../src/functions/log.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,4BAA4B,CAK1C,MAAM,SAAI,GACT,MAAM,GAAG,SAAS,CAiBpB;AAED;;;;;GAKG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAOrC"}
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../../src/functions/log.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,4BAA4B,CAK1C,MAAM,SAAI,GACT,MAAM,GAAG,SAAS,CAiBpB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAOrC"}

package/dist/src/functions/log.lua

@@ -25,7 +25,14 @@ end
 --- Helper function to avoid typing out `Isaac.DebugString()`.
 -- 
 -- If you have the "--luadebug" launch flag turned on or the Racing+ sandbox enabled, then this
--- function will also prepend the function name and the line number before the string.
+-- function will also prepend the function name and the line number before the string, like this:
+-- 
+-- ```text
+-- [INFO] - Lua Debug: saveToDisk:42494 - The save data manager wrote data to the "save#.dat" file.
+-- ```
+-- 
+-- Subsequently, it is recommended that you turn on the "--luadebug" launch flag when developing
+-- your mod so that debugging becomes a little bit easier.
 function ____exports.log(self, msg)
     local parentFunctionDescription = ____exports.getParentFunctionDescription(nil)
     local debugMsg = parentFunctionDescription == nil and msg or (parentFunctionDescription .. " - ") .. msg

package/dist/src/functions/modFeatures.d.ts

@@ -4,6 +4,9 @@ import { ModUpgraded } from "../types/ModUpgraded";
  * Helper function to instantiate an array of mod features all at once. Use this function if your
  * mod uses the pattern of expressing mod features as `ModFeature` classes.
  *
+ * If your feature classes have `v` variables, then this function will successfully register them
+ * with the save data manager.
+ *
  * For example:
  *
  * ```ts

package/dist/src/functions/modFeatures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"modFeatures.d.ts","sourceRoot":"","sources":["../../../src/functions/modFeatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,WAAW,EAChB,WAAW,EAAE,KAAK,CAAC,OAAO,UAAU,CAAC,GACpC,UAAU,EAAE,CAUd"}
+{"version":3,"file":"modFeatures.d.ts","sourceRoot":"","sources":["../../../src/functions/modFeatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,WAAW,EAChB,WAAW,EAAE,KAAK,CAAC,OAAO,UAAU,CAAC,GACpC,UAAU,EAAE,CAYd"}

package/dist/src/functions/modFeatures.lua

@@ -4,6 +4,9 @@ local ____exports = {}
 --- Helper function to instantiate an array of mod features all at once. Use this function if your
 -- mod uses the pattern of expressing mod features as `ModFeature` classes.
 -- 
+-- If your feature classes have `v` variables, then this function will successfully register them
+-- with the save data manager.
+-- 
 -- For example:
 -- 
 -- ```ts
@@ -20,7 +23,8 @@ local ____exports = {}
 function ____exports.initModFeatures(self, mod, modFeatures)
     local instantiatedModFeatures = {}
     for ____, modFeature in ipairs(modFeatures) do
-        local instantiatedModFeature = __TS__New(modFeature, mod)
+        local instantiatedModFeature = __TS__New(modFeature, mod, false)
+        instantiatedModFeature:init()
         instantiatedModFeatures[#instantiatedModFeatures + 1] = instantiatedModFeature
     end
     return instantiatedModFeatures

package/dist/src/interfaces/TSTLClassMetatable.d.ts

@@ -2,6 +2,10 @@
 /// <reference types="lua-types/5.3" />
 /// <reference types="lua-types/5.3" />
 /// <reference types="@typescript-to-lua/language-extensions" />
+/**
+ * This is a type representing the metatable of a user-created class from TypeScript code.
+ * (TypeScriptToLua transpiles TypeScript classes to a Lua table with a specific kind of metatable.)
+ */
 export interface TSTLClassMetatable {
     ____constructor: () => void;
     __index: unknown;

package/dist/src/interfaces/TSTLClassMetatable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TSTLClassMetatable.d.ts","sourceRoot":"","sources":["../../../src/interfaces/TSTLClassMetatable.ts"],"names":[],"mappings":";;;;AAAA,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,MAAM,IAAI,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;KAErD,CAAC;CACH"}
+{"version":3,"file":"TSTLClassMetatable.d.ts","sourceRoot":"","sources":["../../../src/interfaces/TSTLClassMetatable.ts"],"names":[],"mappings":";;;;AAAA;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,MAAM,IAAI,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;KAErD,CAAC;CACH"}

package/dist/src/types/TSTLClass.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="@typescript-to-lua/language-extensions" />
 /**
- * This is a type representing a user-created class from TypeScript code.
+ * This is a type representing a user-created class from TypeScript code. (TypeScriptToLua
+ * transpiles TypeScript classes to a Lua table with a specific kind of metatable.)
  *
  * This type is used by the save data manager to when copying, serializing, and deserializing.
  */

package/dist/src/types/TSTLClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TSTLClass.d.ts","sourceRoot":"","sources":["../../../src/types/TSTLClass.ts"],"names":[],"mappings":";AAAA;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC"}
+{"version":3,"file":"TSTLClass.d.ts","sourceRoot":"","sources":["../../../src/types/TSTLClass.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG;IACnD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "20.11.6",
+  "version": "20.12.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^11.0.0"
+    "isaac-typescript-definitions": "^11.0.1"
   }
 }

package/src/classes/ModFeature.ts

@@ -5,7 +5,7 @@ import {
   getTSTLClassConstructor,
   getTSTLClassName,
 } from "../functions/tstlClass";
-import { isFunction, isNumber } from "../functions/types";
+import { isFunction, isNumber, isTable } from "../functions/types";
 import { TSTLClassMetatable } from "../interfaces/TSTLClassMetatable";
 import { AnyFunction } from "../types/AnyFunction";
 import { ModUpgradedBase } from "./ModUpgradedBase";
@@ -51,6 +51,14 @@ type ModFeatureConstructor = TSTLClassMetatable["constructor"] & {
  * In almost all cases, you will want the callback functions to be immediately subscribed after
  * instantiating the class. However, if this is not the case, you can pass `false` as the optional
  * second argument to the constructor.
+ *
+ * If your mod feature has a property called `v`, it will be assumed that these are variables that
+ * should be managed by the save data manager. Subsequently, they will automatically be registered
+ * with the save data manager upon initialization. Unfortunately, due to technical limitations with
+ * classes, this registration will only occur if you initialize the class with the `init` boolean
+ * argument set to false, and then explicitly call the `ModFeature.init` method yourself after the
+ * class is constructed. (This is because the parent class does not have access to the child's
+ * properties upon first construction.)
  */
 
 export class ModFeature {
@@ -129,6 +137,7 @@ export class ModFeature {
 
     initDecoratedCallbacks(this, constructor, tstlClassName, true, init);
     initDecoratedCallbacks(this, constructor, tstlClassName, false, init);
+    initSaveDataManager(this, tstlClassName, init);
   }
 
   /**
@@ -314,3 +323,53 @@ function removeCallback(
     (mod.RemoveCallbackCustom as AnyFunction)(modCallback, wrappedCallback);
   }
 }
+
+/** This will only work for end-users who are calling the `ModFeature.init` method explicitly. */
+function initSaveDataManager(
+  modFeature: ModFeature,
+  tstlClassName: string,
+  init: boolean,
+) {
+  if (tstlClassName === "AtePoopBaby") {
+    Isaac.DebugString("GETTING HERE 1");
+  }
+
+  // Do nothing if this class does not have any variables.
+  const { v } = modFeature as unknown as Record<string, unknown>;
+  if (v === undefined) {
+    return;
+  }
+
+  Isaac.DebugString("GETTING HERE 2");
+
+  if (!isTable(v)) {
+    error(
+      'Failed to initialize a mod feature class due to having a "v" property that is not an object. (The "v" property is supposed to be an object that holds the variables for the class, managed by the save data manager.)',
+    );
+  }
+
+  // Do nothing if we have not enabled the save data manager.
+  // eslint-disable-next-line @typescript-eslint/dot-notation
+  const mod = modFeature["mod"] as unknown as Record<string, unknown>;
+  const saveDataManagerMethodName = init
+    ? "saveDataManager"
+    : "saveDataManagerRemove";
+  const saveDataManagerMethod = mod[saveDataManagerMethodName];
+  if (saveDataManagerMethod === undefined) {
+    error(
+      'Failed to initialize a mod feature class due to having a "v" object and not having the save data manager initialized. You must pass "ISCFeature.SAVE_DATA_MANAGER" to the "upgradeMod" function.',
+    );
+  }
+
+  if (typeof saveDataManagerMethod !== "function") {
+    error(
+      `The "${saveDataManagerMethodName}" property of the "ModUpgraded" object was not a function.`,
+    );
+  }
+
+  if (init) {
+    saveDataManagerMethod(tstlClassName, v);
+  } else {
+    saveDataManagerMethod(tstlClassName);
+  }
+}

package/src/classes/features/other/CustomTrapdoors.ts

@@ -342,6 +342,8 @@ export class CustomTrapdoors extends Feature {
       const level = game.GetLevel();
       const stage = level.GetStage();
       if (stage !== CUSTOM_FLOOR_STAGE) {
+        // The vanilla streak text shows just before the player stands up, which is a few frames
+        // from now. We arbitrarily play it now instead of waiting to avoid the extra complexity.
         level.ShowName(false);
       }
     });

package/src/functions/log.ts

@@ -37,7 +37,14 @@ export function getParentFunctionDescription(
  * Helper function to avoid typing out `Isaac.DebugString()`.
  *
  * If you have the "--luadebug" launch flag turned on or the Racing+ sandbox enabled, then this
- * function will also prepend the function name and the line number before the string.
+ * function will also prepend the function name and the line number before the string, like this:
+ *
+ * ```text
+ * [INFO] - Lua Debug: saveToDisk:42494 - The save data manager wrote data to the "save#.dat" file.
+ * ```
+ *
+ * Subsequently, it is recommended that you turn on the "--luadebug" launch flag when developing
+ * your mod so that debugging becomes a little bit easier.
  */
 export function log(msg: string): void {
   const parentFunctionDescription = getParentFunctionDescription();

package/src/functions/modFeatures.ts

@@ -5,6 +5,9 @@ import { ModUpgraded } from "../types/ModUpgraded";
  * Helper function to instantiate an array of mod features all at once. Use this function if your
  * mod uses the pattern of expressing mod features as `ModFeature` classes.
  *
+ * If your feature classes have `v` variables, then this function will successfully register them
+ * with the save data manager.
+ *
  * For example:
  *
  * ```ts
@@ -27,7 +30,9 @@ export function initModFeatures(
 
   for (const modFeature of modFeatures) {
     // eslint-disable-next-line new-cap
-    const instantiatedModFeature = new modFeature(mod);
+    const instantiatedModFeature = new modFeature(mod, false);
+    instantiatedModFeature.init();
+
     instantiatedModFeatures.push(instantiatedModFeature);
   }
 

package/src/interfaces/TSTLClassMetatable.ts

@@ -1,3 +1,7 @@
+/**
+ * This is a type representing the metatable of a user-created class from TypeScript code.
+ * (TypeScriptToLua transpiles TypeScript classes to a Lua table with a specific kind of metatable.)
+ */
 export interface TSTLClassMetatable {
   ____constructor: () => void;
   __index: unknown;

package/src/types/TSTLClass.ts

@@ -1,5 +1,6 @@
 /**
- * This is a type representing a user-created class from TypeScript code.
+ * This is a type representing a user-created class from TypeScript code. (TypeScriptToLua
+ * transpiles TypeScript classes to a Lua table with a specific kind of metatable.)
  *
  * This type is used by the save data manager to when copying, serializing, and deserializing.
  */