isaacscript-common 13.2.0 → 13.3.1

package/dist/index.d.ts

@@ -2977,11 +2977,6 @@ data: GridEntityCustomData
  */
 export declare function getCustomGridEntityType(gridEntityOrGridIndex: GridEntity | int): GridEntityType | undefined;
 
-/**
- * Helper function to prefix the name of the function and the line number before a debug message.
- */
-export declare function getDebugPrependString(msg: string, numParentFunctions?: number): string;
-
 /**
  * Helper function to get a set containing all of the global variable names that are contained
  * within the Isaac environment by default.
@@ -3963,6 +3958,18 @@ export declare function getOppositeDoorSlot(doorSlot: DoorSlot): DoorSlot | unde
  */
 export declare function getOtherPlayers(player: EntityPlayer): EntityPlayer[];
 
+/**
+ * Helper function to get the name and the line number of the current calling function.
+ *
+ * For this function to work properly, the "--luadebug" flag must be enabled. Otherwise, it will
+ * always return undefined.
+ *
+ * @param levels Optional. The amount of levels to look backwards in the call stack. Default is 3
+ *               (because the first level is this function, the second level is the calling
+ *               function, and the third level is the parent of the calling function).
+ */
+export declare function getParentFunctionDescription(levels?: number): string | undefined;
+
 /**
  * Helper function to get the closest value from an array of strings based on partial search text.
  * For the purposes of this function, both search text and the array are converted to lowercase
@@ -5195,6 +5202,19 @@ export declare function getTearsStat(fireDelay: float): float;
  */
 export declare function getTeleporters(variant?: number): GridEntity[];
 
+/**
+ * Helper function to get the current time in seconds for benchmarking / profiling purposes.
+ *
+ * - If the "--luadebug" flag is enabled, then this function will use the `socket.gettime` method,
+ *   which returns the epoch timestamp in seconds (e.g. "1640320492.5779"). This is preferable over
+ *   the `Isaac.GetTime` method, since it has one extra decimal point of precision.
+ * - If the "--luadebug" flag is disabled, then this function will use the `Isaac.GetTime` method,
+ *   which returns the number of seconds since the computer's operating system was started (e.g.
+ *   "739454.963"). (The milliseconds return value of `Isaac.GetTime` is converted to seconds to
+ *   align with the return value of `socket.gettime`.)
+ */
+export declare function getTime(): float;
+
 /** Helper function to get all of the `GridEntityTNT` in the room. */
 export declare function getTNT(variant?: number): GridEntityTNT[];
 
@@ -8593,7 +8613,8 @@ export declare enum ModCallbackCustom {
 /**
  * `isaacscript-common` has many custom callbacks that you can use in your mods. Instead of
  * hijacking the vanilla `Mod` object, we provide a `ModUpgraded` object for you to use, which
- * extends the base class and adds a new method of `AddCallbackCustom`.
+ * extends the base class and adds a new method of `AddCallbackCustom`. (There is no corresponding
+ * `RemoveCallbackCustom`.)
  *
  * To upgrade your mod, use the `upgradeMod` helper function.
  */
@@ -8605,7 +8626,9 @@ export declare class ModUpgraded implements Mod {
     Name: string;
     /** We store a copy of the original mod object so that we can re-implement its functions. */
     Mod: Mod;
-    constructor(mod: Mod);
+    Debug: boolean;
+    TimeThreshold: float | undefined;
+    constructor(mod: Mod, debug: boolean, timeThreshold?: float);
     AddCallback<T extends ModCallback>(modCallback: T, ...args: AddCallbackParameter[T]): void;
     HasData(): boolean;
     LoadData(): string;
@@ -11219,6 +11242,8 @@ export declare function setTNTDisplay(textCallback: (tnt: GridEntityTNT) => stri
 /** Helper function to convert a set of flags to a single `BitFlags` object. */
 export declare function setToBitFlags<T extends BitFlag | BitFlag128>(set: Set<T> | ReadonlySet<T>): BitFlags<T>;
 
+export declare function setTracebackFunctionsGlobal(): void;
+
 /**
  * Helper function to change the sprite of a trinket entity.
  *
@@ -12239,9 +12264,13 @@ export declare function unsetHotkey(keyboard: Keyboard): void;
  * ```
  *
  * @param modVanilla The mod object returned by the `RegisterMod` function.
+ * @param debug Optional. Whether to log additional output when a callback is fired. Default is
+ *              false.
+ * @param timeThreshold Optional. If provided, will only log callbacks that take longer than the
+ *                      specified number of seconds.
  * @returns The upgraded mod object.
  */
-export declare function upgradeMod(modVanilla: Mod): ModUpgraded;
+export declare function upgradeMod(modVanilla: Mod, debug?: boolean, timeThreshold?: float): ModUpgraded;
 
 /**
  * Helper function to use an active item without showing an animation, keeping the item, or adding