isaacscript-common 59.2.0 → 59.3.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).

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 59.2.0
+isaacscript-common 59.3.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -54628,6 +54628,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 +54649,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "59.2.0",
+  "version": "59.3.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}`);
+  }
+}