isaacscript-common 59.1.0 → 59.3.0

package/dist/index.rollup.d.ts

@@ -12,7 +12,7 @@ import { ButtonAction } from 'isaac-typescript-definitions';
 import { CacheFlag } from 'isaac-typescript-definitions';
 import { CallbackPriority } from 'isaac-typescript-definitions/dist/src/enums/CallbackPriority';
 import { CardType } from 'isaac-typescript-definitions';
-import type { Challenge } from 'isaac-typescript-definitions';
+import { Challenge } from 'isaac-typescript-definitions';
 import type { CoinSubType } from 'isaac-typescript-definitions';
 import type { CollectiblePedestalType } from 'isaac-typescript-definitions';
 import { CollectibleType } from 'isaac-typescript-definitions';
@@ -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;
 
 /**
@@ -14326,6 +14336,9 @@ export declare const NUM_VANILLA_PILL_EFFECTS: int;
 /** Calculated from the `TrinketType` enum. (`TrinketType.NULL` is not included.) */
 export declare const NUM_VANILLA_TRINKET_TYPES: number;
 
+/** Helper function to see if the player is playing any challenge. */
+export declare function onAnyChallenge(): boolean;
+
 /**
  * Helper function to check if the player has taken Dad's Note. This sets the game state flag of
  * `GameStateFlag.BACKWARDS_PATH` and causes floor generation to change.
@@ -14334,6 +14347,14 @@ export declare function onAscent(): boolean;
 
 export declare function onCathedral(): boolean;
 
+/**
+ * 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
+ * for.
+ */
+export declare function onChallenge(...challenges: Challenge[]): boolean;
+
 export declare function onChest(): boolean;
 
 export declare function onDarkRoom(): boolean;
@@ -16760,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.1.0
+isaacscript-common 59.3.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -54614,7 +54614,11 @@ ____exports.CHALLENGE_NAMES = {
 return ____exports
  end,
 ["src.functions.challenges"] = function(...) 
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
 local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
 local ____challengeBosses = require("src.objects.challengeBosses")
 local CHALLENGE_BOSSES = ____challengeBosses.CHALLENGE_BOSSES
 local DEFAULT_CHALLENGE_BOSS_ID = ____challengeBosses.DEFAULT_CHALLENGE_BOSS_ID
@@ -54624,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
@@ -54636,6 +54649,16 @@ function ____exports.getChallengeName(self, challenge)
     local challengeName = CHALLENGE_NAMES[challenge]
     return challengeName or DEFAULT_CHALLENGE_NAME
 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,4 +1,14 @@
-import type { BossID, Challenge, PlayerType } from "isaac-typescript-definitions";
+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.
  *
@@ -20,4 +30,21 @@ export declare function getChallengeCharacter(challenge: Challenge): PlayerType;
  * For modded challenges, "Unknown" will be returned.
  */
 export declare function getChallengeName(challenge: Challenge): string;
+/** Helper function to see if the player is playing any challenge. */
+export declare function onAnyChallenge(): boolean;
+/**
+ * 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
+ * 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,EACV,MAAM,EACN,SAAS,EACT,UAAU,EACX,MAAM,8BAA8B,CAAC;AActC;;;;;;;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"}
+{"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

@@ -1,4 +1,8 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
 local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
 local ____challengeBosses = require("src.objects.challengeBosses")
 local CHALLENGE_BOSSES = ____challengeBosses.CHALLENGE_BOSSES
 local DEFAULT_CHALLENGE_BOSS_ID = ____challengeBosses.DEFAULT_CHALLENGE_BOSS_ID
@@ -8,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.
@@ -32,4 +52,23 @@ function ____exports.getChallengeName(self, challenge)
     local challengeName = CHALLENGE_NAMES[challenge]
     return challengeName or DEFAULT_CHALLENGE_NAME
 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
+-- for.
+function ____exports.onChallenge(self, ...)
+    local challenges = {...}
+    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.1.0",
+  "version": "59.3.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/challenges.ts

@@ -1,8 +1,5 @@
-import type {
-  BossID,
-  Challenge,
-  PlayerType,
-} from "isaac-typescript-definitions";
+import type { BossID, PlayerType } from "isaac-typescript-definitions";
+import { Challenge } from "isaac-typescript-definitions";
 import {
   CHALLENGE_BOSSES,
   DEFAULT_CHALLENGE_BOSS_ID,
@@ -16,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.
  *
@@ -54,3 +65,33 @@ export function getChallengeName(challenge: Challenge): string {
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   return challengeName ?? DEFAULT_CHALLENGE_NAME;
 }
+
+/** Helper function to see if the player is playing any challenge. */
+export function onAnyChallenge(): boolean {
+  const challenge = Isaac.GetChallenge();
+  return challenge !== Challenge.NULL;
+}
+
+/**
+ * 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
+ * for.
+ */
+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}`);
+  }
+}