isaacscript-common 13.3.0 → 13.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "13.3.0",
+  "version": "13.3.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": "^7.2.8"
+    "isaac-typescript-definitions": "^7.2.9"
   }
 }

package/src/classes/ModUpgraded.ts

@@ -1,7 +1,7 @@
 import { ModCallback } from "isaac-typescript-definitions";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { getTime } from "../functions/benchmark";
-import { log } from "../functions/log";
+import { getParentFunctionDescription } from "../functions/log";
 import { AddCallbackParameterCustom } from "../interfaces/private/AddCallbackParameterCustom";
 import { CALLBACK_REGISTER_FUNCTIONS } from "../objects/callbackRegisterFunctions";
 
@@ -53,12 +53,19 @@ export class ModUpgraded implements Mod {
       const callback = args[0];
       const optionalArg = args[1];
 
+      const parentFunctionDescription = getParentFunctionDescription();
       const callbackName = `ModCallback.${ModCallback[modCallback]}`;
-
-      // We can't use the "log" helper function since that would cause a dependency cycle.
+      const signature =
+        parentFunctionDescription === undefined
+          ? callbackName
+          : `${parentFunctionDescription} - ${callbackName}`;
+
+      /**
+       * We don't use the "log" helper function since it will always show the same "unknown" prefix.
+       */
       const callbackWithLogger = (...callbackArgs: unknown[]) => {
         const startTime = getTime();
-        log(`${callbackName} - START`);
+        Isaac.DebugString(`${signature} - START`);
 
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-expect-error
@@ -70,9 +77,9 @@ export class ModUpgraded implements Mod {
           this.TimeThreshold === undefined ||
           this.TimeThreshold >= elapsedTime
         ) {
-          log(`${callbackName} - END - time: ${elapsedTime}`);
+          Isaac.DebugString(`${signature} - END - time: ${elapsedTime}`);
         } else {
-          log(`${callbackName} - END`);
+          Isaac.DebugString(`${signature} - END`);
         }
       };
 

package/src/functions/log.ts

@@ -1,33 +1,36 @@
 /**
- * Helper function to prefix the name of the function and the line number before a debug message.
+ * 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 function getDebugPrependString(
-  msg: string,
+export function getParentFunctionDescription(
   // We use 3 as a default because:
-  // - 1 - getDebugPrependString
-  // - 2 - calling function
-  // - 3 - the function that calls the calling function
-  numParentFunctions = 3,
-): string {
+  // - The first level is this function.
+  // - The second level is the calling function.
+  // - The third level is the parent of the calling function.
+  levels = 3,
+): string | undefined {
   // "debug" is not always defined like the Lua definitions imply.
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (debug !== undefined) {
     // The "--luadebug" launch flag is enabled.
-    const debugTable = debug.getinfo(numParentFunctions);
+    const debugTable = debug.getinfo(levels);
     if (debugTable !== undefined) {
-      return `${debugTable.name}:${debugTable.linedefined} - ${msg}`;
+      return `${debugTable.name}:${debugTable.linedefined}`;
     }
   }
 
   if (SandboxGetParentFunctionDescription !== undefined) {
     // The Racing+ sandbox is enabled.
-    const parentFunctionDescription = SandboxGetParentFunctionDescription(
-      numParentFunctions + 1,
-    );
-    return `${parentFunctionDescription} - ${msg}`;
+    return SandboxGetParentFunctionDescription(levels);
   }
 
-  return msg;
+  return undefined;
 }
 
 /**
@@ -37,6 +40,10 @@ export function getDebugPrependString(
  * function will also prepend the function name and the line number before the string.
  */
 export function log(msg: string): void {
-  const debugMsg = getDebugPrependString(msg);
+  const parentFunctionDescription = getParentFunctionDescription();
+  const debugMsg =
+    parentFunctionDescription === undefined
+      ? msg
+      : `${parentFunctionDescription} - ${msg}`;
   Isaac.DebugString(debugMsg);
 }