isaacscript-common 13.1.1 → 13.3.0

package/dist/index.d.ts

@@ -5195,6 +5195,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 +8606,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 +8619,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;
@@ -9468,6 +9484,28 @@ export declare function preventChildEntities(entity: Entity): void;
  */
 export declare function preventCollectibleRotation(collectible: EntityPickup, collectibleType: CollectibleType): void;
 
+/**
+ * Helper function to prevent any removed grid entities from respawning if the player re-enters the
+ * room.
+ *
+ * This is accomplished by spawning a new grid entity on every tile that does not already have a
+ * grid entity. This will force the game to spawn the new grid entity instead of the old one. The
+ * natural grid entity to choose for this purpose is a decoration, since it is non-interacting.
+ * Then, the decorations are made invisible and any shovel uses are intercepted to avoid creating a
+ * crawl space (instead of a trapdoor).
+ *
+ * Another option besides decorations would be to use a pressure plates with a state of 1, which is
+ * a state that is normally unused by the game and makes it invisible & persistent. However, pickups
+ * will not be able to spawn on pressure plates, which lead to various bugs (e.g. pickups spawning
+ * on top of pits). Thus, using a decoration is preferable.
+ *
+ * Yet another option to accomplish this would be to replace the room data with that of an empty
+ * room. However, the room data must exactly match the room type, the room shape, and the doors, so
+ * this is not possible to do in a robust way without adding empty rooms to the mod's `content`
+ * folder to draw the data from.
+ */
+export declare function preventGridEntityRespawn(): void;
+
 /**
  * Helper function to print something to the in-game console. Use this instead of invoking the
  * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end
@@ -11197,6 +11235,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.
  *
@@ -12217,9 +12257,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