isaacscript-common 15.1.0 → 15.2.0

package/dist/index.d.ts

@@ -641,6 +641,16 @@ export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set
  *   adds it to the player.
  * - This function should only be used inside the `EVALUATE_CACHE` callback.
  * - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+ *
+ * For example:
+ *
+ * ```ts
+ * function evaluateCacheTears(player: EntityPlayer) {
+ *   const numFoo = player.GetNumCollectible(CollectibleTypeCustom.FOO);
+ *   const tearsStat = numFoo * FOO_TEARS_STAT;
+ *   addTearsStat(player, tearsStat);
+ * }
+ * ```
  */
 export declare function addTearsStat(player: EntityPlayer, tearsStat: float): void;
 
@@ -3427,6 +3437,16 @@ export declare function emptyArray<T>(array: T[]): void;
  */
 export declare function emptyRoom(): void;
 
+/**
+ * A string that represents an entity. This is the entity type, variant, and sub-type, all separated
+ * by periods.
+ *
+ * This type is branded for extra type safety.
+ */
+export declare type EntityID = string & {
+    readonly __entityIDBrand: symbol;
+};
+
 /**
  * Helper function to return an array of integers with the specified range, inclusive on the lower
  * end and exclusive on the high end. (The "e" stands for exclusive.)
@@ -4351,6 +4371,12 @@ export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntit
  */
 export declare function getCombinedBossSet(stage: int): ReadonlySet<string> | undefined;
 
+/** Helper function to get the entity type, variant, and sub-type from an `EntityID`. */
+export declare function getConstituentsFromEntityID(entityID: EntityID): [entityType: EntityType, variant: int, subType: int];
+
+/** Helper function to get the grid entity type and variant from a `GridEntityID`. */
+export declare function getConstituentsFromGridEntityID(gridEntityID: GridEntityID): [gridEntityType: GridEntityType, variant: int];
+
 /**
  * Helper function to get all of the grid entities of type `GridEntityType.CRAWL_SPACE` (18) in the
  * room.
@@ -4518,12 +4544,12 @@ export declare function getEntityFields(entity: Entity): LuaMap<string, boolean
 export declare function getEntityFromPtrHash(ptrHash: PtrHash): Entity | undefined;
 
 /** Helper function to get a string containing the entity's type, variant, and sub-type. */
-export declare function getEntityID(entity: Entity): string;
+export declare function getEntityID(entity: Entity): EntityID;
 
 /**
  * Helper function to get a formatted string in the format returned by the `getEntityID` function.
  */
-export declare function getEntityIDFromConstituents(entityType: EntityType, variant: int, subType: int): string;
+export declare function getEntityIDFromConstituents(entityType: EntityType, variant: int, subType: int): EntityID;
 
 /**
  * Helper function to get a map containing the positions of every entity in the current room.
@@ -4732,13 +4758,13 @@ export declare function getGridEntitiesMap(...gridEntityTypes: GridEntityType[])
 export declare function getGridEntityCollisionPoints(gridEntity: GridEntity): [topLeft: Vector, bottomRight: Vector];
 
 /** Helper function to get a string containing the grid entity's type and variant. */
-export declare function getGridEntityID(gridEntity: GridEntity): string;
+export declare function getGridEntityID(gridEntity: GridEntity): GridEntityID;
 
 /**
  * Helper function to get a formatted string in the format returned by the `getGridEntityID`
  * function.
  */
-export declare function getGridEntityIDFromConstituents(gridEntityType: GridEntityType, variant: int): string;
+export declare function getGridEntityIDFromConstituents(gridEntityType: GridEntityType, variant: int): GridEntityID;
 
 /**
  * Helper function to get the grid index delta that a door out of the given room shape would lead
@@ -6474,6 +6500,16 @@ export declare interface GridEntityCustomData {
     defaultAnimation?: string;
 }
 
+/**
+ * A string that represents a grid entity. This is the entity type and variant separated by a
+ * period.
+ *
+ * This type is branded for extra type safety.
+ */
+export declare type GridEntityID = string & {
+    readonly __gridEntityIDBrand: symbol;
+};
+
 declare class GridEntityRenderDetection extends Feature {
     private postGridEntityRender;
     private postGridEntityCustomRender;
@@ -6701,7 +6737,7 @@ export declare function inBossRoomOf(bossID: BossID): boolean;
 /**
  * Helper function for non-TypeScript users to check if an element is in an array.
  *
- * Since this takes O(N) time, using this function is usually a mistake, since you can use a `Map`
+ * Since this takes O(N) time, using this function is usually a mistake, since you can use a `Set`
  * data structure to get O(1) lookups.
  *
  * Internally, this just calls `array.includes`.
@@ -10647,10 +10683,20 @@ declare class ModdedElementSets extends Feature {
  * mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
  * that automatically subscribe to callbacks.
  *
+ * If your feature has variables that are managed by the save data manager, put them as a `v` class
+ * member and they will automatically be registered with the save data manager when the class is
+ * instantiated.
+ *
  * For example:
  *
  * ```ts
  * export class MyFeature extends ModFeature {
+ *   v = {
+ *     run: {
+ *       foo: 123,
+ *     }
+ *   }
+ *
  *   @Callback(ModCallback.POST_GAME_STARTED)
  *   postGameStarted(isContinued: boolean): void {
  *     Isaac.DebugString(`Callback fired: POST_GAME_STARTED`);
@@ -13347,6 +13393,16 @@ export declare type SoulHeartType = HeartSubType.SOUL | HeartSubType.BLACK | Hea
  * need to specify the velocity or spawner.
  *
  * Also see the `spawnWithSeed` helper function.
+ *
+ * @param entityType The `EntityType` of the entity to spawn.
+ * @param variant The variant of the entity to spawn.
+ * @param subType The sub-type of the entity to spawn.
+ * @param position The position of the entity to spawn.
+ * @param velocity Optional. The velocity of the entity to spawn. Default is `VectorZero`.
+ * @param spawner Optional. The entity that will be the `SpawnerEntity`. Default is undefined.
+ * @param seedOrRNG Optional. The seed or RNG object to use to generate the `InitSeed` of the
+ *                  entity. Default is undefined, which will make the entity spawn with a random
+ *                  seed using the `Isaac.Spawn` method.
  */
 export declare function spawn(entityType: EntityType, variant: int, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): Entity;
 
@@ -13517,6 +13573,19 @@ export declare function spawnEffectWithSeed(effectVariant: EffectVariant, subTyp
  */
 export declare function spawnEmptyCollectible(position: Vector, seedOrRNG?: Seed | RNG): EntityPickup;
 
+/**
+ * Helper function to spawn the entity corresponding to an `EntityID`.
+ *
+ * @param entityID The `EntityID` of the entity to spawn.
+ * @param position The position of the entity to spawn.
+ * @param velocity Optional. The velocity of the entity to spawn. Default is `VectorZero`.
+ * @param spawner Optional. The entity that will be the `SpawnerEntity`. Default is undefined.
+ * @param seedOrRNG Optional. The seed or RNG object to use to generate the `InitSeed` of the
+ *                  entity. Default is undefined, which will make the entity spawn with a random
+ *                  seed using the `Isaac.Spawn` method.
+ */
+export declare function spawnEntityID(entityID: EntityID, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): Entity;
+
 /**
  * Helper function to spawn a `EntityType.FAMILIAR` (3).
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 15.1.0
+isaacscript-common 15.2.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -19088,15 +19088,19 @@ return ____exports
  end,
 ["src.types.AnyEntity"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.types.EntityID"] = function(...) 
+local ____exports = {}
 return ____exports
  end,
 ["src.functions.entities"] = function(...) 
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
+local __TS__StringSplit = ____lualib.__TS__StringSplit
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
-local __TS__StringSplit = ____lualib.__TS__StringSplit
 local ____exports = {}
 local setPrimitiveEntityFields
 local ____cachedClasses = require("src.core.cachedClasses")
@@ -19217,6 +19221,26 @@ function ____exports.getClosestEntityTo(self, referenceEntity, entities)
     end
     return closestEntity
 end
+function ____exports.getConstituentsFromEntityID(self, entityID)
+    local parts = __TS__StringSplit(entityID, ".")
+    if #parts ~= 3 then
+        error("Failed to get the constituents from entity ID: " .. entityID)
+    end
+    local entityTypeString, variantString, subTypeString = table.unpack(parts)
+    local entityType = tonumber(entityTypeString)
+    if entityType == nil then
+        error("Failed to convert the entity type to a number: " .. tostring(entityTypeString))
+    end
+    local variant = tonumber(variantString)
+    if variant == nil then
+        error("Failed to convert the entity variant to a number: " .. tostring(variantString))
+    end
+    local subType = tonumber(subTypeString)
+    if subType == nil then
+        error("Failed to convert the entity sub-type to a number: " .. tostring(subTypeString))
+    end
+    return {entityType, variant, subType}
+end
 function ____exports.getEntities(self, entityType, variant, subType, ignoreFriendly)
     if entityType == nil then
         entityType = -1
@@ -19411,6 +19435,28 @@ function ____exports.spawn(self, entityType, variant, subType, position, velocit
         seed
     )
 end
+function ____exports.spawnEntityID(self, entityID, position, velocity, spawner, seedOrRNG)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seedOrRNG == nil then
+        seedOrRNG = nil
+    end
+    local entityType, variant, subType = table.unpack(____exports.getConstituentsFromEntityID(nil, entityID))
+    return ____exports.spawn(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seedOrRNG
+    )
+end
 function ____exports.spawnWithSeed(self, entityType, variant, subType, position, seedOrRNG, velocity, spawner)
     if velocity == nil then
         velocity = VectorZero
@@ -24658,6 +24704,10 @@ return ____exports
  end,
 ["src.types.AnyGridEntity"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.types.GridEntityID"] = function(...) 
+local ____exports = {}
 return ____exports
  end,
 ["src.objects.roomTypeNames"] = function(...) 
@@ -25424,6 +25474,7 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__StringSplit = ____lualib.__TS__StringSplit
 local Map = ____lualib.Map
 local ____exports = {}
 local getAllGridEntities
@@ -25592,6 +25643,22 @@ function ____exports.getCollidingEntitiesWithGridEntity(self, gridEntity)
         ) end
     )
 end
+function ____exports.getConstituentsFromGridEntityID(self, gridEntityID)
+    local parts = __TS__StringSplit(gridEntityID, ".")
+    if #parts ~= 2 then
+        error("Failed to get the constituents from grid entity ID: " .. gridEntityID)
+    end
+    local gridEntityTypeString, variantString = table.unpack(parts)
+    local gridEntityType = tonumber(gridEntityTypeString)
+    if gridEntityType == nil then
+        error("Failed to convert the grid entity type to a number: " .. tostring(gridEntityTypeString))
+    end
+    local variant = tonumber(variantString)
+    if variant == nil then
+        error("Failed to convert the grid entity variant to a number: " .. tostring(variantString))
+    end
+    return {gridEntityType, variant}
+end
 function ____exports.getGridEntities(self, ...)
     local gridEntityTypes = {...}
     local gridEntities = getAllGridEntities(nil)
@@ -25639,7 +25706,7 @@ function ____exports.getGridEntitiesInRadius(self, targetPosition, radius)
                 local gridIndex = room:GetGridIndex(position)
                 local gridEntity = room:GetGridEntityFromPos(position)
                 if gridEntity == nil or registeredGridIndexes:has(gridIndex) then
-                    goto __continue20
+                    goto __continue24
                 end
                 registeredGridIndexes:add(gridIndex)
                 local topLeft, bottomRight = table.unpack(____exports.getGridEntityCollisionPoints(nil, gridEntity))
@@ -25653,7 +25720,7 @@ function ____exports.getGridEntitiesInRadius(self, targetPosition, radius)
                     gridEntities[#gridEntities + 1] = gridEntity
                 end
             end
-            ::__continue20::
+            ::__continue24::
         end
     end
     return gridEntities
@@ -48279,7 +48346,6 @@ return ____exports
 ["src.classes.ModFeature"] = function(...) 
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
-local __TS__Spread = ____lualib.__TS__Spread
 local ____exports = {}
 local checkAddDecoratedCallbacks, checkAddDecoratedCallbacksCustom, checkRegisterSaveDataManager
 local ____tstlClass = require("src.functions.tstlClass")
@@ -48287,22 +48353,56 @@ local getTSTLClassConstructor = ____tstlClass.getTSTLClassConstructor
 local getTSTLClassName = ____tstlClass.getTSTLClassName
 local ____types = require("src.functions.types")
 local isTable = ____types.isTable
-function checkAddDecoratedCallbacks(self, mod, modFeatureConstructor)
+function checkAddDecoratedCallbacks(self, mod, modFeatureConstructor, modFeature)
     local addCallbackArgs = modFeatureConstructor[____exports.ADD_CALLBACK_ARGS_KEY]
     if addCallbackArgs == nil then
         return
     end
+    local tstlClassName = getTSTLClassName(nil, modFeatureConstructor) or "Unknown"
     for ____, args in ipairs(addCallbackArgs) do
-        mod:AddCallback(__TS__Spread(args))
+        local parameters = args
+        local modCallback = table.remove(parameters, 1)
+        if modCallback == nil then
+            error("Failed to get the ModCallback from the parameters for class: " .. tstlClassName)
+        end
+        local callback = table.remove(parameters, 1)
+        if callback == nil then
+            error("Failed to get the callback from the parameters for class: " .. tstlClassName)
+        end
+        local function newCallback(____, ...)
+            callback(modFeature, ...)
+        end
+        mod:AddCallback(
+            modCallback,
+            newCallback,
+            table.unpack(parameters)
+        )
     end
 end
-function checkAddDecoratedCallbacksCustom(self, mod, modFeatureConstructor)
+function checkAddDecoratedCallbacksCustom(self, mod, modFeatureConstructor, modFeature)
     local addCallbackCustomArgs = modFeatureConstructor[____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY]
     if addCallbackCustomArgs == nil then
         return
     end
+    local tstlClassName = getTSTLClassName(nil, modFeatureConstructor) or "Unknown"
     for ____, args in ipairs(addCallbackCustomArgs) do
-        mod:AddCallbackCustom(__TS__Spread(args))
+        local parameters = args
+        local modCallbackCustom = table.remove(parameters, 1)
+        if modCallbackCustom == nil then
+            error("Failed to get the ModCallbackCustom from the parameters for class: " .. tstlClassName)
+        end
+        local callback = table.remove(parameters, 1)
+        if callback == nil then
+            error("Failed to get the callback from the parameters for class: " .. tstlClassName)
+        end
+        local function newCallback(____, ...)
+            callback(modFeature, ...)
+        end
+        mod:AddCallbackCustom(
+            modCallbackCustom,
+            newCallback,
+            table.unpack(parameters)
+        )
     end
 end
 function checkRegisterSaveDataManager(self, mod, modFeature)
@@ -48333,8 +48433,8 @@ function ModFeature.prototype.____constructor(self, mod)
         error("Failed to get the TSTL class constructor for a mod feature.")
     end
     local modFeatureConstructor = constructor
-    checkAddDecoratedCallbacks(nil, mod, modFeatureConstructor)
-    checkAddDecoratedCallbacksCustom(nil, mod, modFeatureConstructor)
+    checkAddDecoratedCallbacks(nil, mod, modFeatureConstructor, self)
+    checkAddDecoratedCallbacksCustom(nil, mod, modFeatureConstructor, self)
     checkRegisterSaveDataManager(nil, mod, self)
 end
 return ____exports
@@ -48712,6 +48812,8 @@ local ____exports = {}
 local ____ModFeature = require("src.classes.ModFeature")
 local ADD_CALLBACK_ARGS_KEY = ____ModFeature.ADD_CALLBACK_ARGS_KEY
 local ADD_CALLBACK_CUSTOM_ARGS_KEY = ____ModFeature.ADD_CALLBACK_CUSTOM_ARGS_KEY
+local ____tstlClass = require("src.functions.tstlClass")
+local getTSTLClassName = ____tstlClass.getTSTLClassName
 function ____exports.Callback(self, modCallback, ...)
     local optionalArgs = {...}
     return function(____, target, propertyKey, _descriptor)
@@ -48723,6 +48825,10 @@ function ____exports.Callback(self, modCallback, ...)
             __TS__Spread(optionalArgs)
         }
         local constructor = target.constructor
+        if constructor == nil then
+            local tstlClassName = getTSTLClassName(nil, target) or "Unknown"
+            error(("Failed to get the constructor for class \"" .. tstlClassName) .. "\". Did you decorate a static method? You can only decorate non-static class methods, because the \"Mod\" object is not present before the class is instantiated.")
+        end
         if not (constructor[ADD_CALLBACK_ARGS_KEY] ~= nil) then
             constructor[ADD_CALLBACK_ARGS_KEY] = {}
         end
@@ -48741,6 +48847,10 @@ function ____exports.CallbackCustom(self, modCallbackCustom, ...)
             __TS__Spread(optionalArgs)
         }
         local constructor = target.constructor
+        if constructor == nil then
+            local tstlClassName = getTSTLClassName(nil, target) or "Unknown"
+            error(("Failed to get the constructor for class \"" .. tstlClassName) .. "\". Did you decorate a static method? You can only decorate non-static class methods, because the \"Mod\" object is not present before the class is instantiated.")
+        end
         if not (constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY] ~= nil) then
             constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY] = {}
         end

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

@@ -6,10 +6,20 @@ export declare const ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs";
  * mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
  * that automatically subscribe to callbacks.
  *
+ * If your feature has variables that are managed by the save data manager, put them as a `v` class
+ * member and they will automatically be registered with the save data manager when the class is
+ * instantiated.
+ *
  * For example:
  *
  * ```ts
  * export class MyFeature extends ModFeature {
+ *   v = {
+ *     run: {
+ *       foo: 123,
+ *     }
+ *   }
+ *
  *   @Callback(ModCallback.POST_GAME_STARTED)
  *   postGameStarted(isContinued: boolean): void {
  *     Isaac.DebugString(`Callback fired: POST_GAME_STARTED`);

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

@@ -1 +1 @@
-{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,qBAAqB,sBAAsB,CAAC;AACzD,eAAO,MAAM,4BAA4B,4BAA4B,CAAC;AAOtE;;;;;;;;;;;;;;;GAeG;AAEH,qBAAa,UAAU;gBACT,GAAG,EAAE,eAAe;CAWjC"}
+{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,qBAAqB,sBAAsB,CAAC;AACzD,eAAO,MAAM,4BAA4B,4BAA4B,CAAC;AAOtE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,qBAAa,UAAU;gBACT,GAAG,EAAE,eAAe;CAWjC"}

package/dist/src/classes/ModFeature.lua

@@ -1,6 +1,5 @@
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
-local __TS__Spread = ____lualib.__TS__Spread
 local ____exports = {}
 local checkAddDecoratedCallbacks, checkAddDecoratedCallbacksCustom, checkRegisterSaveDataManager
 local ____tstlClass = require("src.functions.tstlClass")
@@ -8,22 +7,60 @@ local getTSTLClassConstructor = ____tstlClass.getTSTLClassConstructor
 local getTSTLClassName = ____tstlClass.getTSTLClassName
 local ____types = require("src.functions.types")
 local isTable = ____types.isTable
-function checkAddDecoratedCallbacks(self, mod, modFeatureConstructor)
+function checkAddDecoratedCallbacks(self, mod, modFeatureConstructor, modFeature)
     local addCallbackArgs = modFeatureConstructor[____exports.ADD_CALLBACK_ARGS_KEY]
     if addCallbackArgs == nil then
         return
     end
+    local tstlClassName = getTSTLClassName(nil, modFeatureConstructor) or "Unknown"
     for ____, args in ipairs(addCallbackArgs) do
-        mod:AddCallback(__TS__Spread(args))
+        local parameters = args
+        local modCallback = table.remove(parameters, 1)
+        if modCallback == nil then
+            error("Failed to get the ModCallback from the parameters for class: " .. tstlClassName)
+        end
+        local callback = table.remove(parameters, 1)
+        if callback == nil then
+            error("Failed to get the callback from the parameters for class: " .. tstlClassName)
+        end
+        --- We need to wrap the callback in a new function so that we can explicitly pass the class as
+        -- the first argument. (Otherwise, the method will not be able to properly access `this`.
+        local function newCallback(____, ...)
+            callback(modFeature, ...)
+        end
+        mod:AddCallback(
+            modCallback,
+            newCallback,
+            table.unpack(parameters)
+        )
     end
 end
-function checkAddDecoratedCallbacksCustom(self, mod, modFeatureConstructor)
+function checkAddDecoratedCallbacksCustom(self, mod, modFeatureConstructor, modFeature)
     local addCallbackCustomArgs = modFeatureConstructor[____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY]
     if addCallbackCustomArgs == nil then
         return
     end
+    local tstlClassName = getTSTLClassName(nil, modFeatureConstructor) or "Unknown"
     for ____, args in ipairs(addCallbackCustomArgs) do
-        mod:AddCallbackCustom(__TS__Spread(args))
+        local parameters = args
+        local modCallbackCustom = table.remove(parameters, 1)
+        if modCallbackCustom == nil then
+            error("Failed to get the ModCallbackCustom from the parameters for class: " .. tstlClassName)
+        end
+        local callback = table.remove(parameters, 1)
+        if callback == nil then
+            error("Failed to get the callback from the parameters for class: " .. tstlClassName)
+        end
+        --- We need to wrap the callback in a new function so that we can explicitly pass the class as
+        -- the first argument. (Otherwise, the method will not be able to properly access `this`.
+        local function newCallback(____, ...)
+            callback(modFeature, ...)
+        end
+        mod:AddCallbackCustom(
+            modCallbackCustom,
+            newCallback,
+            table.unpack(parameters)
+        )
     end
 end
 function checkRegisterSaveDataManager(self, mod, modFeature)
@@ -49,10 +86,19 @@ ____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs"
 -- mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
 -- that automatically subscribe to callbacks.
 -- 
+-- If your feature has variables that are managed by the save data manager, put them as a `v` class
+-- member and they will automatically be registered with the save data manager when the class is
+-- instantiated.
+-- 
 -- For example:
 -- 
 -- ```ts
 -- export class MyFeature extends ModFeature {
+--   v = {
+--     run: {
+--       foo: 123,
+--     }
+--   }
 -- 
 -- @Callback (ModCallback.POST_GAME_STARTED)
 -- postGameStarted(isContinued: boolean): void {
@@ -69,8 +115,8 @@ function ModFeature.prototype.____constructor(self, mod)
         error("Failed to get the TSTL class constructor for a mod feature.")
     end
     local modFeatureConstructor = constructor
-    checkAddDecoratedCallbacks(nil, mod, modFeatureConstructor)
-    checkAddDecoratedCallbacksCustom(nil, mod, modFeatureConstructor)
+    checkAddDecoratedCallbacks(nil, mod, modFeatureConstructor, self)
+    checkAddDecoratedCallbacksCustom(nil, mod, modFeatureConstructor, self)
     checkRegisterSaveDataManager(nil, mod, self)
 end
 return ____exports

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

@@ -36,7 +36,7 @@ export declare function forEach<T>(array: T[], func: (value: T, index: number, a
 /**
  * Helper function for non-TypeScript users to check if an element is in an array.
  *
- * Since this takes O(N) time, using this function is usually a mistake, since you can use a `Map`
+ * Since this takes O(N) time, using this function is usually a mistake, since you can use a `Set`
  * data structure to get O(1) lookups.
  *
  * Internally, this just calls `array.includes`.

package/dist/src/functions/arrayLua.lua

@@ -36,7 +36,7 @@ function ____exports.forEach(self, array, func)
 end
 --- Helper function for non-TypeScript users to check if an element is in an array.
 -- 
--- Since this takes O(N) time, using this function is usually a mistake, since you can use a `Map`
+-- Since this takes O(N) time, using this function is usually a mistake, since you can use a `Set`
 -- data structure to get O(1) lookups.
 -- 
 -- Internally, this just calls `array.includes`.

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

@@ -1 +1 @@
-{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../src/functions/decorators.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAGL,UAAU,EACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,WAAW,EAC5C,WAAW,EAAE,CAAC,EACd,GAAG,YAAY,EAAE,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,kGAIvC,MAAM,+CAElB,IAAI,CAwBR;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,iBAAiB,EACxD,iBAAiB,EAAE,CAAC,EACpB,GAAG,YAAY,EAAE,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,wGAO7C,MAAM,+CAElB,IAAI,CA0BR"}
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../src/functions/decorators.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAGL,UAAU,EACX,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGnD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,WAAW,EAC5C,WAAW,EAAE,CAAC,EACd,GAAG,YAAY,EAAE,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,kGAIvC,MAAM,+CAElB,IAAI,CA+BR;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,iBAAiB,EACxD,iBAAiB,EAAE,CAAC,EACpB,GAAG,YAAY,EAAE,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,wGAO7C,MAAM,+CAElB,IAAI,CAiCR"}

package/dist/src/functions/decorators.lua

@@ -4,6 +4,8 @@ local ____exports = {}
 local ____ModFeature = require("src.classes.ModFeature")
 local ADD_CALLBACK_ARGS_KEY = ____ModFeature.ADD_CALLBACK_ARGS_KEY
 local ADD_CALLBACK_CUSTOM_ARGS_KEY = ____ModFeature.ADD_CALLBACK_CUSTOM_ARGS_KEY
+local ____tstlClass = require("src.functions.tstlClass")
+local getTSTLClassName = ____tstlClass.getTSTLClassName
 --- A decorator function that signifies that the decorated class method should be automatically
 -- registered with `Mod.AddCallback`.
 -- 
@@ -19,6 +21,10 @@ function ____exports.Callback(self, modCallback, ...)
             __TS__Spread(optionalArgs)
         }
         local constructor = target.constructor
+        if constructor == nil then
+            local tstlClassName = getTSTLClassName(nil, target) or "Unknown"
+            error(("Failed to get the constructor for class \"" .. tstlClassName) .. "\". Did you decorate a static method? You can only decorate non-static class methods, because the \"Mod\" object is not present before the class is instantiated.")
+        end
         if not (constructor[ADD_CALLBACK_ARGS_KEY] ~= nil) then
             constructor[ADD_CALLBACK_ARGS_KEY] = {}
         end
@@ -41,6 +47,10 @@ function ____exports.CallbackCustom(self, modCallbackCustom, ...)
             __TS__Spread(optionalArgs)
         }
         local constructor = target.constructor
+        if constructor == nil then
+            local tstlClassName = getTSTLClassName(nil, target) or "Unknown"
+            error(("Failed to get the constructor for class \"" .. tstlClassName) .. "\". Did you decorate a static method? You can only decorate non-static class methods, because the \"Mod\" object is not present before the class is instantiated.")
+        end
         if not (constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY] ~= nil) then
             constructor[ADD_CALLBACK_CUSTOM_ARGS_KEY] = {}
         end

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

@@ -1,6 +1,7 @@
 /// <reference types="@typescript-to-lua/language-extensions" />
 import { EntityType } from "isaac-typescript-definitions";
 import { AnyEntity } from "../types/AnyEntity";
+import { EntityID } from "../types/EntityID";
 /**
  * Helper function to count the number of entities in room. Use this over the vanilla
  * `Isaac.CountEntities` method to avoid having to specify a spawner and to handle ignoring charmed
@@ -35,6 +36,8 @@ export declare function doesEntityExist(entityType?: EntityType, variant?: numbe
  * ```
  */
 export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity: Entity, entities: T[]): T | undefined;
+/** Helper function to get the entity type, variant, and sub-type from an `EntityID`. */
+export declare function getConstituentsFromEntityID(entityID: EntityID): [entityType: EntityType, variant: int, subType: int];
 /**
  * Helper function to get all of the entities in the room or all of the entities that match a
  * specific entity type / variant / sub-type.
@@ -78,11 +81,11 @@ export declare function getEntityFields(entity: Entity): LuaMap<string, boolean
  */
 export declare function getEntityFromPtrHash(ptrHash: PtrHash): Entity | undefined;
 /** Helper function to get a string containing the entity's type, variant, and sub-type. */
-export declare function getEntityID(entity: Entity): string;
+export declare function getEntityID(entity: Entity): EntityID;
 /**
  * Helper function to get a formatted string in the format returned by the `getEntityID` function.
  */
-export declare function getEntityIDFromConstituents(entityType: EntityType, variant: int, subType: int): string;
+export declare function getEntityIDFromConstituents(entityType: EntityType, variant: int, subType: int): EntityID;
 /**
  * Helper function to compare two different arrays of entities. Returns the entities that are in the
  * second array but not in the first array.
@@ -170,8 +173,30 @@ export declare function setEntityRandomColor(entity: Entity): void;
  * need to specify the velocity or spawner.
  *
  * Also see the `spawnWithSeed` helper function.
+ *
+ * @param entityType The `EntityType` of the entity to spawn.
+ * @param variant The variant of the entity to spawn.
+ * @param subType The sub-type of the entity to spawn.
+ * @param position The position of the entity to spawn.
+ * @param velocity Optional. The velocity of the entity to spawn. Default is `VectorZero`.
+ * @param spawner Optional. The entity that will be the `SpawnerEntity`. Default is undefined.
+ * @param seedOrRNG Optional. The seed or RNG object to use to generate the `InitSeed` of the
+ *                  entity. Default is undefined, which will make the entity spawn with a random
+ *                  seed using the `Isaac.Spawn` method.
  */
 export declare function spawn(entityType: EntityType, variant: int, subType: int, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): Entity;
+/**
+ * Helper function to spawn the entity corresponding to an `EntityID`.
+ *
+ * @param entityID The `EntityID` of the entity to spawn.
+ * @param position The position of the entity to spawn.
+ * @param velocity Optional. The velocity of the entity to spawn. Default is `VectorZero`.
+ * @param spawner Optional. The entity that will be the `SpawnerEntity`. Default is undefined.
+ * @param seedOrRNG Optional. The seed or RNG object to use to generate the `InitSeed` of the
+ *                  entity. Default is undefined, which will make the entity spawn with a random
+ *                  seed using the `Isaac.Spawn` method.
+ */
+export declare function spawnEntityID(entityID: EntityID, position: Vector, velocity?: Vector, spawner?: Entity | undefined, seedOrRNG?: Seed | RNG | undefined): Entity;
 /**
  * Helper function to spawn an entity. Use this instead of the `Game.Spawn` method if you do not
  * need to specify the velocity or spawner.