isaacscript-common 13.3.2 → 13.3.4

package/dist/index.d.ts

@@ -79,7 +79,7 @@ import { TrapdoorVariant } from 'isaac-typescript-definitions';
 import { TrinketType } from 'isaac-typescript-definitions';
 import { UseFlag } from 'isaac-typescript-definitions';
 
-declare interface AddCallbackParameterCustom {
+declare interface AddCallbackParametersCustom {
     [ModCallbackCustom.POST_AMBUSH_FINISHED]: PostAmbushFinishedRegisterParameters;
     [ModCallbackCustom.POST_AMBUSH_STARTED]: PostAmbushStartedRegisterParameters;
     [ModCallbackCustom.POST_BOMB_EXPLODED]: PostBombExplodedRegisterParameters;
@@ -5203,17 +5203,24 @@ 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.
+ * Helper function to get the current time 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`.)
+ * The return value will either be in seconds or milliseconds, depending on if the "--luadebug" flag
+ * is turned on or not.
+ *
+ * If the "--luadebug" flag is present, 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 more conventional `Isaac.GetTime` method, since it has one extra decimal point of precision.
+ *
+ * If the "--luadebug" flag is not present, then this function will use the `Isaac.GetTime` method,
+ * which returns the number of milliseconds since the computer's operating system was started (e.g.
+ * "739454963").
+ *
+ * @param useSocketIfAvailable Optional. Whether to use the `socket.gettime` method, if available.
+ *                             Default is true. If set to false, the `Isaac.GetTime()` method will
+ *                             always be used.
  */
-export declare function getTime(): float;
+export declare function getTime(useSocketIfAvailable?: boolean): float;
 
 /** Helper function to get all of the `GridEntityTNT` in the room. */
 export declare function getTNT(variant?: number): GridEntityTNT[];
@@ -8613,8 +8620,7 @@ 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`. (There is no corresponding
- * `RemoveCallbackCustom`.)
+ * extends the base class and adds a new method of `AddCallbackCustom`.
  *
  * To upgrade your mod, use the `upgradeMod` helper function.
  */
@@ -8629,17 +8635,22 @@ export declare class ModUpgraded implements Mod {
     Debug: boolean;
     TimeThreshold: float | undefined;
     constructor(mod: Mod, debug: boolean, timeThreshold?: float);
-    AddCallback<T extends ModCallback>(modCallback: T, ...args: AddCallbackParameter[T]): void;
+    AddCallback<T extends ModCallback>(modCallback: T, ...args: AddCallbackParameters[T]): void;
     HasData(): boolean;
     LoadData(): string;
     /**
      * This method does not care about the tertiary argument. Regardless of the conditions of how you
      * registered the callback, it will be removed.
      */
-    RemoveCallback<T extends ModCallback>(modCallback: T, callback: AddCallbackParameter[T][0]): void;
+    RemoveCallback<T extends ModCallback>(modCallback: T, callback: AddCallbackParameters[T][0]): void;
     RemoveData(): void;
     SaveData(data: string): void;
-    AddCallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...args: AddCallbackParameterCustom[T]): void;
+    AddCallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...args: AddCallbackParametersCustom[T]): void;
+    /**
+     * This method does not care about the tertiary argument. Regardless of the conditions of how you
+     * registered the callback, it will be removed.
+     */
+    RemoveCallbackCustom<T extends ModCallbackCustom>(modCallback: T, callback: AddCallbackParametersCustom[T][0]): void;
 }
 
 /**
@@ -12267,7 +12278,8 @@ export declare function unsetHotkey(keyboard: Keyboard): void;
  * @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.
+ *                      specified number of seconds (if the "--luadebug" launch flag is turned on)
+ *                      or milliseconds (if the "--luadebug" launch flag is turned off).
  * @returns The upgraded mod object.
  */
 export declare function upgradeMod(modVanilla: Mod, debug?: boolean, timeThreshold?: float): ModUpgraded;