isaacscript-common 13.1.1 → 13.3.0

package/src/features/deployJSONRoom.ts

@@ -36,6 +36,7 @@ import {
   getGridEntities,
   removeGridEntity,
   setGridEntityInvisible,
+  spawnGridEntity,
   spawnGridEntityWithVariant,
 } from "../functions/gridEntities";
 import { getRandomJSONEntity, getRandomJSONRoom } from "../functions/jsonRoom";
@@ -145,6 +146,11 @@ function preUseItemWeNeedToGoDeeper(
       return;
     }
 
+    const futureRoomListIndex = getRoomListIndex();
+    if (futureRoomListIndex !== roomListIndex) {
+      return;
+    }
+
     v.room.manuallyUsingShovel = true;
     futurePlayer.UseActiveItem(CollectibleType.WE_NEED_TO_GO_DEEPER);
     v.room.manuallyUsingShovel = false;
@@ -152,7 +158,7 @@ function preUseItemWeNeedToGoDeeper(
     const decorationGridIndexes =
       v.level.roomToDecorationGridIndexesMap.getAndSetDefault(roomListIndex);
     emptyArray(decorationGridIndexes);
-    fillRoomWithDecorations();
+    preventGridEntityRespawn();
   });
 
   // Cancel the original effect.
@@ -273,7 +279,7 @@ export function deployJSONRoom(
   }
 
   fixPitGraphics();
-  fillRoomWithDecorations();
+  preventGridEntityRespawn();
 }
 
 /**
@@ -328,27 +334,35 @@ export function deployRandomJSONRoom(
 }
 
 /**
- * We removed most normal entities, which should prevent them from respawning when the player
- * re-enters the room. However, this is not the case for grid entities; even if they are removed,
- * they will come back when the player re-enters the room.
+ * Helper function to prevent any removed grid entities from respawning if the player re-enters the
+ * room.
  *
- * In order to prevent this from happening, we can spawn a grid entity on every tile that does not
- * already have a grid entity. The natural grid entity to choose for this purpose is a decoration,
- * since it is non-interacting.
+ * 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, we use a decoration and remove its sprite to make it invisible.
+ * on top of pits). Thus, using a decoration is preferable.
  *
- * Yet another option is 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.
+ * 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.
  */
-function fillRoomWithDecorations() {
+export function preventGridEntityRespawn(): void {
+  errorIfFeaturesNotInitialized(FEATURE_NAME);
+
   const room = game.GetRoom();
   const roomListIndex = getRoomListIndex();
 
+  // Ensure that this room is in the deployed room set, or else the shovel interception code will
+  // not work properly.
+  v.level.deployedRoomListIndexes.add(roomListIndex);
+
   const decorationGridIndexes =
     v.level.roomToDecorationGridIndexesMap.getAndSetDefault(roomListIndex);
 
@@ -358,9 +372,7 @@ function fillRoomWithDecorations() {
       continue;
     }
 
-    const position = room.GetGridPosition(gridIndex);
-    const decoration = Isaac.GridSpawn(GridEntityType.DECORATION, 0, position);
-
+    const decoration = spawnGridEntity(GridEntityType.DECORATION, gridIndex);
     if (decoration !== undefined) {
       setGridEntityInvisible(decoration);
     }

package/src/features/extraConsoleCommands/listCommands.ts

@@ -83,7 +83,7 @@ import {
   logRoom,
   logSeedEffects,
   logSounds,
-} from "../../functions/log";
+} from "../../functions/logMisc";
 import { getMapPartialMatch } from "../../functions/map";
 import { runMergeTests } from "../../functions/mergeTests";
 import {

package/src/features/pause.ts

@@ -12,7 +12,7 @@ import {
   removeAllTears,
 } from "../functions/entitiesSpecific";
 import { isTear } from "../functions/isaacAPIClass";
-import { logError } from "../functions/log";
+import { logError } from "../functions/logMisc";
 import { getAllPlayers } from "../functions/playerIndex";
 import { useActiveItemTemp } from "../functions/players";
 import { disableAllInputsExceptFor, enableAllInputs } from "./disableInputs";

package/src/features/saveDataManager/load.ts

@@ -1,5 +1,6 @@
 import { jsonDecode } from "../../functions/jsonHelpers";
-import { log, logError } from "../../functions/log";
+import { log } from "../../functions/log";
+import { logError } from "../../functions/logMisc";
 import { iterateTableInOrder } from "../../functions/table";
 import { isString, isTable } from "../../functions/types";
 import { SaveData } from "../../interfaces/SaveData";

package/src/features/saveDataManager/main.ts

@@ -5,7 +5,7 @@ import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
 import { SaveDataKey } from "../../enums/SaveDataKey";
 import { SerializationType } from "../../enums/SerializationType";
 import { deepCopy } from "../../functions/deepCopy";
-import { logError } from "../../functions/log";
+import { logError } from "../../functions/logMisc";
 import { onFirstFloor } from "../../functions/stage";
 import { clearTable, iterateTableInOrder } from "../../functions/table";
 import { SaveData } from "../../interfaces/SaveData";

package/src/features/taintedLazarusPlayers.ts

@@ -4,7 +4,7 @@
 import { ModCallback, PlayerType } from "isaac-typescript-definitions";
 import { ModUpgraded } from "../classes/ModUpgraded";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { logError } from "../functions/log";
+import { logError } from "../functions/logMisc";
 import { saveDataManager } from "./saveDataManager/exports";
 
 const FEATURE_NAME = "taintedLazarusPlayers";

package/src/functions/benchmark.ts

@@ -1,3 +1,4 @@
+import { SECOND_IN_MILLISECONDS } from "../core/constants";
 import { log } from "./log";
 
 /**
@@ -39,3 +40,25 @@ export function benchmark(
 
   return averages;
 }
+
+/**
+ * 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 function getTime(): float {
+  const [ok, requiredSocket] = pcall(require, "socket");
+  if (ok) {
+    const socket = requiredSocket as Socket;
+    return socket.gettime();
+  }
+
+  // The "--luadebug" launch option is not enabled.
+  return Isaac.GetTime() / SECOND_IN_MILLISECONDS;
+}

package/src/functions/debugFunctions.ts

@@ -6,6 +6,7 @@ import { saveDataManagerSetGlobal } from "../features/saveDataManager/exports";
 import * as logExports from "./log";
 import { log } from "./log";
 import * as logEntitiesExports from "./logEntities";
+import * as logMiscExports from "./logMisc";
 
 /**
  * Helper function to enable some IsaacScript features that are useful when developing a mod. They
@@ -27,6 +28,7 @@ import * as logEntitiesExports from "./logEntities";
 export function enableDevFeatures(mod: ModUpgraded): void {
   saveDataManagerSetGlobal();
   setLogFunctionsGlobal();
+  setTracebackFunctionsGlobal();
   enableExtraConsoleCommands(mod);
   enableFastReset();
   removeFadeIn();
@@ -45,8 +47,8 @@ export function getTraceback(): string {
     return debug.traceback();
   }
 
-  if (sandboxGetTraceback !== undefined) {
-    return sandboxGetTraceback();
+  if (SandboxGetTraceback !== undefined) {
+    return SandboxGetTraceback();
   }
 
   return 'stack traceback:\n(the "--luadebug" flag is not enabled)';
@@ -81,13 +83,19 @@ export function isLuaDebugEnabled(): boolean {
 export function setLogFunctionsGlobal(): void {
   const globals = _G as Record<string, unknown>;
 
-  for (const [logFuncName, logFunc] of Object.entries(logExports)) {
-    globals[logFuncName] = logFunc;
+  for (const exports of [logExports, logMiscExports, logEntitiesExports]) {
+    // eslint-disable-next-line isaacscript/no-object-any
+    for (const [logFuncName, logFunc] of Object.entries(exports)) {
+      globals[logFuncName] = logFunc;
+    }
   }
+}
 
-  for (const [logFuncName, logFunc] of Object.entries(logEntitiesExports)) {
-    globals[logFuncName] = logFunc;
-  }
+export function setTracebackFunctionsGlobal(): void {
+  const globals = _G as Record<string, unknown>;
+
+  globals["getTraceback"] = getTraceback;
+  globals["traceback"] = traceback;
 }
 
 /**
@@ -101,21 +109,3 @@ export function traceback(): void {
   const tracebackOutput = getTraceback();
   log(tracebackOutput);
 }
-
-// If the debug functions will provide useful output, make them global by default.
-if (isLuaDebugEnabled() || sandboxGetTraceback !== undefined) {
-  setDebugFunctionsGlobal();
-}
-
-function setDebugFunctionsGlobal() {
-  // "debug" is not always defined like the Lua definitions imply.
-  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  if (_G.debug === undefined && sandboxGetTraceback === undefined) {
-    return;
-  }
-
-  const globals = _G as Record<string, unknown>;
-
-  globals["getTraceback"] = getTraceback;
-  globals["traceback"] = traceback;
-}

package/src/functions/globals.ts

@@ -205,7 +205,7 @@ export function getDefaultGlobals(): ReadonlySet<string> {
 }
 
 function isRacingPlusSandboxEnabled() {
-  return getParentFunctionDescription !== undefined;
+  return SandboxGetParentFunctionDescription !== undefined;
 }
 
 /**

package/src/functions/hex.ts

@@ -1,4 +1,4 @@
-import { logError } from "./log";
+import { logError } from "./logMisc";
 
 const HEX_STRING_LENGTH = 6;
 

package/src/functions/jsonHelpers.ts

@@ -1,5 +1,5 @@
 import * as jsonLua from "../lib/jsonLua";
-import { logError } from "./log";
+import { logError } from "./logMisc";
 
 function tryDecode(this: void, jsonString: string) {
   return jsonLua.decode(jsonString) as LuaMap<AnyNotNil, unknown>;