isaacscript-common 59.2.0 → 59.4.0

package/dist/index.rollup.d.ts

@@ -1550,6 +1550,16 @@ export declare const CHEST_PICKUP_VARIANTS_SET: ReadonlySet<PickupVariant>;
  */
 export declare function clamp(num: int, min: int, max: int): int;
 
+/**
+ * Helper function to clear the current challenge, which will restart the run on a new random
+ * non-challenge seed with the current character.
+ *
+ * If the player is not in a challenge already, this function will do nothing.
+ *
+ * Under the hood, this function executes the `challenge 0` console command.
+ */
+export declare function clearChallenge(): void;
+
 export declare function clearCollectibleSprite(collectible: EntityPickup): void;
 
 /**
@@ -16771,6 +16781,15 @@ export declare function setBackdrop(backdropType: BackdropType): void;
  */
 export declare function setBlindfold(player: EntityPlayer, enabled: boolean, modifyCostume?: boolean): void;
 
+/**
+ * Helper function to restart the run on a particular challenge.
+ *
+ * If the player is already in the particular challenge, this function will do nothing.
+ *
+ * Under the hood, this function executes the `challenge 0` console command.
+ */
+export declare function setChallenge(challenge: Challenge): void;
+
 /**
  * Helper function to set a collectible sprite to a question mark (i.e. how collectibles look when
  * the player has Curse of the Blind).
@@ -16986,6 +17005,16 @@ export declare function setRoomDisplayFlags(roomGridIndex: int | undefined, disp
  */
 export declare function setRoomUncleared(): void;
 
+/**
+ * Helper function to restart the run on a particular starting seed.
+ *
+ * Under the hood, this function executes the `seed` console command.
+ *
+ * @param startSeedOrStartSeedString Either the numerical start seed (e.g. 268365970) or the start
+ *                                 seed string (e.g. "AAJ2 8V9C").
+ */
+export declare function setRunSeed(startSeedOrStartSeedString: Seed | string): void;
+
 /** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
 export declare function setSeed(rng: RNG, seed: Seed): void;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 59.2.0
+isaacscript-common 59.4.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -22636,6 +22636,8 @@ local ____entitiesSpecific = require("src.functions.entitiesSpecific")
 local spawnSlot = ____entitiesSpecific.spawnSlot
 local ____log = require("src.functions.log")
 local log = ____log.log
+local ____types = require("src.functions.types")
+local isString = ____types.isString
 function ____exports.anySeedEffectEnabled(self)
     local seeds = game:GetSeeds()
     local numSeedEffects = seeds:CountSeedEffects()
@@ -22685,6 +22687,10 @@ function ____exports.restart(self, character)
     log((((("Restarting the run as " .. characterName) .. " (") .. tostring(character)) .. ") with a console command of: ") .. command)
     Isaac.ExecuteCommand(command)
 end
+function ____exports.setRunSeed(self, startSeedOrStartSeedString)
+    local startSeedString = isString(nil, startSeedOrStartSeedString) and startSeedOrStartSeedString or Seeds.Seed2String(startSeedOrStartSeedString)
+    Isaac.ExecuteCommand("seed " .. startSeedString)
+end
 function ____exports.setUnseeded(self)
     local seeds = game:GetSeeds()
     seeds:Reset()
@@ -54628,6 +54634,15 @@ local DEFAULT_CHALLENGE_CHARACTER = ____challengeCharacters.DEFAULT_CHALLENGE_CH
 local ____challengeNames = require("src.objects.challengeNames")
 local CHALLENGE_NAMES = ____challengeNames.CHALLENGE_NAMES
 local DEFAULT_CHALLENGE_NAME = ____challengeNames.DEFAULT_CHALLENGE_NAME
+function ____exports.onAnyChallenge(self)
+    local challenge = Isaac.GetChallenge()
+    return challenge ~= Challenge.NULL
+end
+function ____exports.clearChallenge(self)
+    if ____exports.onAnyChallenge(nil) then
+        Isaac.ExecuteCommand("challenge " .. tostring(Challenge.NULL))
+    end
+end
 function ____exports.getChallengeBoss(self, challenge)
     local challengeBossID = CHALLENGE_BOSSES[challenge]
     return challengeBossID or DEFAULT_CHALLENGE_BOSS_ID
@@ -54640,15 +54655,16 @@ function ____exports.getChallengeName(self, challenge)
     local challengeName = CHALLENGE_NAMES[challenge]
     return challengeName or DEFAULT_CHALLENGE_NAME
 end
-function ____exports.onAnyChallenge(self)
-    local challenge = Isaac.GetChallenge()
-    return challenge ~= Challenge.NULL
-end
 function ____exports.onChallenge(self, ...)
     local challenges = {...}
     local challenge = Isaac.GetChallenge()
     return __TS__ArrayIncludes(challenges, challenge)
 end
+function ____exports.setChallenge(self, challenge)
+    if not ____exports.onChallenge(nil, challenge) then
+        Isaac.ExecuteCommand("challenge " .. tostring(challenge))
+    end
+end
 return ____exports
  end,
 ["src.interfaces.ChargeBarSprites"] = function(...) 

package/dist/src/functions/challenges.d.ts

@@ -1,5 +1,14 @@
 import type { BossID, PlayerType } from "isaac-typescript-definitions";
 import { Challenge } from "isaac-typescript-definitions";
+/**
+ * Helper function to clear the current challenge, which will restart the run on a new random
+ * non-challenge seed with the current character.
+ *
+ * If the player is not in a challenge already, this function will do nothing.
+ *
+ * Under the hood, this function executes the `challenge 0` console command.
+ */
+export declare function clearChallenge(): void;
 /**
  * Get the final boss of a challenge. This will only work for vanilla challenges.
  *
@@ -30,4 +39,12 @@ export declare function onAnyChallenge(): boolean;
  * for.
  */
 export declare function onChallenge(...challenges: Challenge[]): boolean;
+/**
+ * Helper function to restart the run on a particular challenge.
+ *
+ * If the player is already in the particular challenge, this function will do nothing.
+ *
+ * Under the hood, this function executes the `challenge 0` console command.
+ */
+export declare function setChallenge(challenge: Challenge): void;
 //# sourceMappingURL=challenges.d.ts.map

package/dist/src/functions/challenges.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"challenges.d.ts","sourceRoot":"","sources":["../../../src/functions/challenges.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAczD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAK7D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,UAAU,CAKtE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAK7D;AAED,qEAAqE;AACrE,wBAAgB,cAAc,IAAI,OAAO,CAGxC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAG/D"}
+{"version":3,"file":"challenges.d.ts","sourceRoot":"","sources":["../../../src/functions/challenges.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAczD;;;;;;;GAOG;AACH,wBAAgB,cAAc,IAAI,IAAI,CAIrC;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAK7D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,GAAG,UAAU,CAKtE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAK7D;AAED,qEAAqE;AACrE,wBAAgB,cAAc,IAAI,OAAO,CAGxC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAG/D;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvD"}

package/dist/src/functions/challenges.lua

@@ -12,6 +12,22 @@ local DEFAULT_CHALLENGE_CHARACTER = ____challengeCharacters.DEFAULT_CHALLENGE_CH
 local ____challengeNames = require("src.objects.challengeNames")
 local CHALLENGE_NAMES = ____challengeNames.CHALLENGE_NAMES
 local DEFAULT_CHALLENGE_NAME = ____challengeNames.DEFAULT_CHALLENGE_NAME
+--- Helper function to see if the player is playing any challenge.
+function ____exports.onAnyChallenge(self)
+    local challenge = Isaac.GetChallenge()
+    return challenge ~= Challenge.NULL
+end
+--- Helper function to clear the current challenge, which will restart the run on a new random
+-- non-challenge seed with the current character.
+-- 
+-- If the player is not in a challenge already, this function will do nothing.
+-- 
+-- Under the hood, this function executes the `challenge 0` console command.
+function ____exports.clearChallenge(self)
+    if ____exports.onAnyChallenge(nil) then
+        Isaac.ExecuteCommand("challenge " .. tostring(Challenge.NULL))
+    end
+end
 --- Get the final boss of a challenge. This will only work for vanilla challenges.
 -- 
 -- For modded challenges, `BossID.MOM` (6) will be returned.
@@ -36,11 +52,6 @@ function ____exports.getChallengeName(self, challenge)
     local challengeName = CHALLENGE_NAMES[challenge]
     return challengeName or DEFAULT_CHALLENGE_NAME
 end
---- Helper function to see if the player is playing any challenge.
-function ____exports.onAnyChallenge(self)
-    local challenge = Isaac.GetChallenge()
-    return challenge ~= Challenge.NULL
-end
 --- Helper function to check to see if the player is playing a particular challenge.
 -- 
 -- This function is variadic, meaning that you can specify as many challenges as you want to check
@@ -50,4 +61,14 @@ function ____exports.onChallenge(self, ...)
     local challenge = Isaac.GetChallenge()
     return __TS__ArrayIncludes(challenges, challenge)
 end
+--- Helper function to restart the run on a particular challenge.
+-- 
+-- If the player is already in the particular challenge, this function will do nothing.
+-- 
+-- Under the hood, this function executes the `challenge 0` console command.
+function ____exports.setChallenge(self, challenge)
+    if not ____exports.onChallenge(nil, challenge) then
+        Isaac.ExecuteCommand("challenge " .. tostring(challenge))
+    end
+end
 return ____exports

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

@@ -45,6 +45,15 @@ export declare function onVictoryLap(): 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 the run on a particular starting seed.
+ *
+ * Under the hood, this function executes the `seed` console command.
+ *
+ * @param startSeedOrStartSeedString Either the numerical start seed (e.g. 268365970) or the start
+ *                                 seed string (e.g. "AAJ2 8V9C").
+ */
+export declare function setRunSeed(startSeedOrStartSeedString: Seed | string): void;
 /**
  * Helper function to change the run status to that of an unseeded run with a new random seed.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAGL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAStC,qDAAqD;AACrD,wBAAgB,mBAAmB,IAAI,OAAO,CAE7C;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAK9C;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,OAAO,CAUlD;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,UAAU,EAAE,CAO7C;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAKrC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAkBpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAUlC"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAGL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAUtC,qDAAqD;AACrD,wBAAgB,mBAAmB,IAAI,OAAO,CAE7C;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAK9C;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,OAAO,CAUlD;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,UAAU,EAAE,CAO7C;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAKrC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;GAGG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAGtC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAkBpD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,0BAA0B,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAM1E;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAUlC"}

package/dist/src/functions/run.lua

@@ -20,6 +20,8 @@ local ____entitiesSpecific = require("src.functions.entitiesSpecific")
 local spawnSlot = ____entitiesSpecific.spawnSlot
 local ____log = require("src.functions.log")
 local log = ____log.log
+local ____types = require("src.functions.types")
+local isString = ____types.isString
 --- Helper function to see if any seed effects (i.e. Easter Eggs) are enabled for the current run.
 function ____exports.anySeedEffectEnabled(self)
     local seeds = game:GetSeeds()
@@ -92,6 +94,16 @@ function ____exports.restart(self, character)
     log((((("Restarting the run as " .. characterName) .. " (") .. tostring(character)) .. ") with a console command of: ") .. command)
     Isaac.ExecuteCommand(command)
 end
+--- Helper function to restart the run on a particular starting seed.
+-- 
+-- Under the hood, this function executes the `seed` console command.
+-- 
+-- @param startSeedOrStartSeedString Either the numerical start seed (e.g. 268365970) or the start
+-- seed string (e.g. "AAJ2 8V9C").
+function ____exports.setRunSeed(self, startSeedOrStartSeedString)
+    local startSeedString = isString(nil, startSeedOrStartSeedString) and startSeedOrStartSeedString or Seeds.Seed2String(startSeedOrStartSeedString)
+    Isaac.ExecuteCommand("seed " .. startSeedString)
+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 seed and restarting the game will

package/package.json

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

package/src/functions/challenges.ts

@@ -13,6 +13,20 @@ import {
   DEFAULT_CHALLENGE_NAME,
 } from "../objects/challengeNames";
 
+/**
+ * Helper function to clear the current challenge, which will restart the run on a new random
+ * non-challenge seed with the current character.
+ *
+ * If the player is not in a challenge already, this function will do nothing.
+ *
+ * Under the hood, this function executes the `challenge 0` console command.
+ */
+export function clearChallenge(): void {
+  if (onAnyChallenge()) {
+    Isaac.ExecuteCommand(`challenge ${Challenge.NULL}`);
+  }
+}
+
 /**
  * Get the final boss of a challenge. This will only work for vanilla challenges.
  *
@@ -68,3 +82,16 @@ export function onChallenge(...challenges: Challenge[]): boolean {
   const challenge = Isaac.GetChallenge();
   return challenges.includes(challenge);
 }
+
+/**
+ * Helper function to restart the run on a particular challenge.
+ *
+ * If the player is already in the particular challenge, this function will do nothing.
+ *
+ * Under the hood, this function executes the `challenge 0` console command.
+ */
+export function setChallenge(challenge: Challenge): void {
+  if (!onChallenge(challenge)) {
+    Isaac.ExecuteCommand(`challenge ${challenge}`);
+  }
+}

package/src/functions/run.ts

@@ -12,6 +12,7 @@ import { FIRST_CHARACTER } from "../core/constantsFirstLast";
 import { getCharacterName } from "./characters";
 import { spawnSlot } from "./entitiesSpecific";
 import { log } from "./log";
+import { isString } from "./types";
 
 /** Alias for the `anySeedEffectEnabled` function. */
 export function anyEasterEggEnabled(): boolean {
@@ -122,6 +123,22 @@ export function restart(character?: PlayerType): void {
   Isaac.ExecuteCommand(command);
 }
 
+/**
+ * Helper function to restart the run on a particular starting seed.
+ *
+ * Under the hood, this function executes the `seed` console command.
+ *
+ * @param startSeedOrStartSeedString Either the numerical start seed (e.g. 268365970) or the start
+ *                                 seed string (e.g. "AAJ2 8V9C").
+ */
+export function setRunSeed(startSeedOrStartSeedString: Seed | string): void {
+  const startSeedString = isString(startSeedOrStartSeedString)
+    ? startSeedOrStartSeedString
+    : Seeds.Seed2String(startSeedOrStartSeedString);
+
+  Isaac.ExecuteCommand(`seed ${startSeedString}`);
+}
+
 /**
  * Helper function to change the run status to that of an unseeded run with a new random seed.
  *