isaacscript-common 6.8.0 → 6.9.0

package/dist/functions/run.d.ts

@@ -13,6 +13,14 @@ export declare function onSetSeed(): boolean;
  * You can optionally specify a `PlayerType` to restart the game as that character.
  */
 export declare function restart(character?: PlayerType): void;
+/**
+ * Helper function to restart on the next render frame. Useful because it is impossible to restart
+ * the game inside of the `POST_NEW_ROOM`, `POST_NEW_LEVEL`, or `POST_GAME_STARTED` callbacks when a
+ * run is first starting.
+ *
+ * You can optionally specify a `PlayerType` to restart the game as that character.
+ */
+export declare function restartNextRenderFrame(character?: PlayerType): void;
 /**
  * Helper function to change the run status to that of an unseeded run with a new random seed.
  *

package/dist/functions/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAKrE;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAiBpD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAUlC"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAMrE;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAiBpD;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAInE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAUlC"}

package/dist/functions/run.lua

@@ -6,6 +6,8 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constantsFirstLast = require("constantsFirstLast")
 local FIRST_CHARACTER = ____constantsFirstLast.FIRST_CHARACTER
+local ____runInNFrames = require("features.runInNFrames")
+local runNextRenderFrame = ____runInNFrames.runNextRenderFrame
 local ____log = require("functions.log")
 local log = ____log.log
 --- Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
@@ -36,6 +38,19 @@ function ____exports.restart(self, character)
     log((((("Restarting the run as PlayerType." .. tostring(PlayerType[character])) .. " (") .. tostring(character)) .. ") with a console command of: ") .. command)
     Isaac.ExecuteCommand(command)
 end
+--- Helper function to restart on the next render frame. Useful because it is impossible to restart
+-- the game inside of the `POST_NEW_ROOM`, `POST_NEW_LEVEL`, or `POST_GAME_STARTED` callbacks when a
+-- run is first starting.
+-- 
+-- You can optionally specify a `PlayerType` to restart the game as that character.
+function ____exports.restartNextRenderFrame(self, character)
+    runNextRenderFrame(
+        nil,
+        function()
+            ____exports.restart(nil, character)
+        end
+    )
+end
 --- Helper function to change the run status to that of an unseeded run with a new random seed.
 -- 
 -- This is useful to revert the behavior where playing on a set and restarting the game will not

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "6.8.0",
+  "version": "6.9.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/run.ts

@@ -1,6 +1,7 @@
 import { Challenge, PlayerType } from "isaac-typescript-definitions";
 import { game } from "../cachedClasses";
 import { FIRST_CHARACTER } from "../constantsFirstLast";
+import { runNextRenderFrame } from "../features/runInNFrames";
 import { log } from "./log";
 
 /**
@@ -42,6 +43,19 @@ export function restart(character?: PlayerType): void {
   Isaac.ExecuteCommand(command);
 }
 
+/**
+ * Helper function to restart on the next render frame. Useful because it is impossible to restart
+ * the game inside of the `POST_NEW_ROOM`, `POST_NEW_LEVEL`, or `POST_GAME_STARTED` callbacks when a
+ * run is first starting.
+ *
+ * You can optionally specify a `PlayerType` to restart the game as that character.
+ */
+export function restartNextRenderFrame(character?: PlayerType): void {
+  runNextRenderFrame(() => {
+    restart(character);
+  });
+}
+
 /**
  * Helper function to change the run status to that of an unseeded run with a new random seed.
  *