isaacscript-common 57.5.0 → 57.7.0

package/dist/index.rollup.d.ts

@@ -5031,6 +5031,16 @@ export declare function getCardName(cardType: CardType): string;
  */
 export declare function getCards(cardType?: CardType | -1): EntityPickupCard[];
 
+/**
+ * Get the final boss of a challenge. This will only work for vanilla challenges.
+ *
+ * For modded challenges, `BossID.MOM` (6) will be returned.
+ *
+ * Note that for `Challenge.BACKASSWARDS` (31), this function will return `BossID.MEGA_SATAN` (55),
+ * but this is not actually the final boss. (There is no final boss for this challenge.)
+ */
+export declare function getChallengeBoss(challenge: Challenge): BossID;
+
 /**
  * Get the starting character of a challenge. This will only work for vanilla challenges.
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 57.5.0
+isaacscript-common 57.7.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -54364,6 +54364,62 @@ function ____exports.getBombRadiusFromDamage(self, damage)
     end
     return 90
 end
+return ____exports
+ end,
+["src.objects.challengeBosses"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
+local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
+____exports.DEFAULT_CHALLENGE_BOSS_ID = BossID.MOM
+____exports.CHALLENGE_BOSSES = {
+    [Challenge.NULL] = BossID.MOM,
+    [Challenge.PITCH_BLACK] = BossID.MOM,
+    [Challenge.HIGH_BROW] = BossID.MOM,
+    [Challenge.HEAD_TRAUMA] = BossID.MOM,
+    [Challenge.DARKNESS_FALLS] = BossID.SATAN,
+    [Challenge.TANK] = BossID.MOM,
+    [Challenge.SOLAR_SYSTEM] = BossID.MOMS_HEART,
+    [Challenge.SUICIDE_KING] = BossID.ISAAC,
+    [Challenge.CAT_GOT_YOUR_TONGUE] = BossID.MOM,
+    [Challenge.DEMO_MAN] = BossID.MOMS_HEART,
+    [Challenge.CURSED] = BossID.MOM,
+    [Challenge.GLASS_CANNON] = BossID.SATAN,
+    [Challenge.WHEN_LIFE_GIVES_LEMONS] = BossID.MOM,
+    [Challenge.BEANS] = BossID.MOM,
+    [Challenge.ITS_IN_THE_CARDS] = BossID.MOM,
+    [Challenge.SLOW_ROLL] = BossID.MOM,
+    [Challenge.COMPUTER_SAVY] = BossID.MOM,
+    [Challenge.WAKA_WAKA] = BossID.MOM,
+    [Challenge.HOST] = BossID.MOM,
+    [Challenge.FAMILY_MAN] = BossID.ISAAC,
+    [Challenge.PURIST] = BossID.MOMS_HEART,
+    [Challenge.XXXXXXXXL] = BossID.MOMS_HEART,
+    [Challenge.SPEED] = BossID.MOMS_HEART,
+    [Challenge.BLUE_BOMBER] = BossID.SATAN,
+    [Challenge.PAY_TO_PLAY] = BossID.ISAAC,
+    [Challenge.HAVE_A_HEART] = BossID.MOMS_HEART,
+    [Challenge.I_RULE] = BossID.MEGA_SATAN,
+    [Challenge.BRAINS] = BossID.BLUE_BABY,
+    [Challenge.PRIDE_DAY] = BossID.MOMS_HEART,
+    [Challenge.ONANS_STREAK] = BossID.ISAAC,
+    [Challenge.GUARDIAN] = BossID.MOMS_HEART,
+    [Challenge.BACKASSWARDS] = BossID.MEGA_SATAN,
+    [Challenge.APRILS_FOOL] = BossID.MOMS_HEART,
+    [Challenge.POKEY_MANS] = BossID.ISAAC,
+    [Challenge.ULTRA_HARD] = BossID.MEGA_SATAN,
+    [Challenge.PONG] = BossID.BLUE_BABY,
+    [Challenge.SCAT_MAN] = BossID.MOM,
+    [Challenge.BLOODY_MARY] = BossID.SATAN,
+    [Challenge.BAPTISM_BY_FIRE] = BossID.SATAN,
+    [Challenge.ISAACS_AWAKENING] = BossID.MOTHER,
+    [Challenge.SEEING_DOUBLE] = BossID.MOMS_HEART,
+    [Challenge.PICA_RUN] = BossID.ISAAC,
+    [Challenge.HOT_POTATO] = BossID.SATAN,
+    [Challenge.CANTRIPPED] = BossID.MOM,
+    [Challenge.RED_REDEMPTION] = BossID.MOTHER,
+    [Challenge.DELETE_THIS] = BossID.BLUE_BABY
+}
 return ____exports
  end,
 ["src.objects.challengeCharacters"] = function(...) 
@@ -54479,12 +54535,19 @@ return ____exports
  end,
 ["src.functions.challenges"] = function(...) 
 local ____exports = {}
+local ____challengeBosses = require("src.objects.challengeBosses")
+local CHALLENGE_BOSSES = ____challengeBosses.CHALLENGE_BOSSES
+local DEFAULT_CHALLENGE_BOSS_ID = ____challengeBosses.DEFAULT_CHALLENGE_BOSS_ID
 local ____challengeCharacters = require("src.objects.challengeCharacters")
 local CHALLENGE_CHARACTERS = ____challengeCharacters.CHALLENGE_CHARACTERS
 local DEFAULT_CHALLENGE_CHARACTER = ____challengeCharacters.DEFAULT_CHALLENGE_CHARACTER
 local ____challengeNames = require("src.objects.challengeNames")
 local CHALLENGE_NAMES = ____challengeNames.CHALLENGE_NAMES
 local DEFAULT_CHALLENGE_NAME = ____challengeNames.DEFAULT_CHALLENGE_NAME
+function ____exports.getChallengeBoss(self, challenge)
+    local challengeBossID = CHALLENGE_BOSSES[challenge]
+    return challengeBossID or DEFAULT_CHALLENGE_BOSS_ID
+end
 function ____exports.getChallengeCharacter(self, challenge)
     local challengeCharacter = CHALLENGE_CHARACTERS[challenge]
     return challengeCharacter or DEFAULT_CHALLENGE_CHARACTER

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

@@ -1,4 +1,13 @@
-import type { Challenge, PlayerType } from "isaac-typescript-definitions";
+import type { BossID, Challenge, PlayerType } from "isaac-typescript-definitions";
+/**
+ * Get the final boss of a challenge. This will only work for vanilla challenges.
+ *
+ * For modded challenges, `BossID.MOM` (6) will be returned.
+ *
+ * Note that for `Challenge.BACKASSWARDS` (31), this function will return `BossID.MEGA_SATAN` (55),
+ * but this is not actually the final boss. (There is no final boss for this challenge.)
+ */
+export declare function getChallengeBoss(challenge: Challenge): BossID;
 /**
  * Get the starting character of a challenge. This will only work for vanilla challenges.
  *

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,SAAS,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAU1E;;;;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,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"}

package/dist/src/functions/challenges.lua

@@ -1,10 +1,23 @@
 local ____exports = {}
+local ____challengeBosses = require("src.objects.challengeBosses")
+local CHALLENGE_BOSSES = ____challengeBosses.CHALLENGE_BOSSES
+local DEFAULT_CHALLENGE_BOSS_ID = ____challengeBosses.DEFAULT_CHALLENGE_BOSS_ID
 local ____challengeCharacters = require("src.objects.challengeCharacters")
 local CHALLENGE_CHARACTERS = ____challengeCharacters.CHALLENGE_CHARACTERS
 local DEFAULT_CHALLENGE_CHARACTER = ____challengeCharacters.DEFAULT_CHALLENGE_CHARACTER
 local ____challengeNames = require("src.objects.challengeNames")
 local CHALLENGE_NAMES = ____challengeNames.CHALLENGE_NAMES
 local DEFAULT_CHALLENGE_NAME = ____challengeNames.DEFAULT_CHALLENGE_NAME
+--- Get the final boss of a challenge. This will only work for vanilla challenges.
+-- 
+-- For modded challenges, `BossID.MOM` (6) will be returned.
+-- 
+-- Note that for `Challenge.BACKASSWARDS` (31), this function will return `BossID.MEGA_SATAN` (55),
+-- but this is not actually the final boss. (There is no final boss for this challenge.)
+function ____exports.getChallengeBoss(self, challenge)
+    local challengeBossID = CHALLENGE_BOSSES[challenge]
+    return challengeBossID or DEFAULT_CHALLENGE_BOSS_ID
+end
 --- Get the starting character of a challenge. This will only work for vanilla challenges.
 -- 
 -- For modded challenges, `PlayerType.ISAAC` (0) will be returned.

package/dist/src/objects/challengeBosses.d.ts

@@ -0,0 +1,56 @@
+import { BossID } from "isaac-typescript-definitions";
+export declare const DEFAULT_CHALLENGE_BOSS_ID = BossID.MOM;
+/**
+ * Taken from the "challenges.xml" file.
+ *
+ * @see https://bindingofisaacrebirth.fandom.com/wiki/Challenges
+ */
+export declare const CHALLENGE_BOSSES: {
+    readonly 0: BossID.MOM;
+    readonly 1: BossID.MOM;
+    readonly 2: BossID.MOM;
+    readonly 3: BossID.MOM;
+    readonly 4: BossID.SATAN;
+    readonly 5: BossID.MOM;
+    readonly 6: BossID.MOMS_HEART;
+    readonly 7: BossID.ISAAC;
+    readonly 8: BossID.MOM;
+    readonly 9: BossID.MOMS_HEART;
+    readonly 10: BossID.MOM;
+    readonly 11: BossID.SATAN;
+    readonly 12: BossID.MOM;
+    readonly 13: BossID.MOM;
+    readonly 14: BossID.MOM;
+    readonly 15: BossID.MOM;
+    readonly 16: BossID.MOM;
+    readonly 17: BossID.MOM;
+    readonly 18: BossID.MOM;
+    readonly 19: BossID.ISAAC;
+    readonly 20: BossID.MOMS_HEART;
+    readonly 21: BossID.MOMS_HEART;
+    readonly 22: BossID.MOMS_HEART;
+    readonly 23: BossID.SATAN;
+    readonly 24: BossID.ISAAC;
+    readonly 25: BossID.MOMS_HEART;
+    readonly 26: BossID.MEGA_SATAN;
+    readonly 27: BossID.BLUE_BABY;
+    readonly 28: BossID.MOMS_HEART;
+    readonly 29: BossID.ISAAC;
+    readonly 30: BossID.MOMS_HEART;
+    readonly 31: BossID.MEGA_SATAN;
+    readonly 32: BossID.MOMS_HEART;
+    readonly 33: BossID.ISAAC;
+    readonly 34: BossID.MEGA_SATAN;
+    readonly 35: BossID.BLUE_BABY;
+    readonly 36: BossID.MOM;
+    readonly 37: BossID.SATAN;
+    readonly 38: BossID.SATAN;
+    readonly 39: BossID.MOTHER;
+    readonly 40: BossID.MOMS_HEART;
+    readonly 41: BossID.ISAAC;
+    readonly 42: BossID.SATAN;
+    readonly 43: BossID.MOM;
+    readonly 44: BossID.MOTHER;
+    readonly 45: BossID.BLUE_BABY;
+};
+//# sourceMappingURL=challengeBosses.d.ts.map

package/dist/src/objects/challengeBosses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"challengeBosses.d.ts","sourceRoot":"","sources":["../../../src/objects/challengeBosses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAa,MAAM,8BAA8B,CAAC;AAEjE,eAAO,MAAM,yBAAyB,aAAa,CAAC;AAEpD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+CiB,CAAC"}

package/dist/src/objects/challengeBosses.lua

@@ -0,0 +1,57 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
+local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
+____exports.DEFAULT_CHALLENGE_BOSS_ID = BossID.MOM
+--- Taken from the "challenges.xml" file.
+-- 
+-- @see https ://bindingofisaacrebirth.fandom.com/wiki/Challenges
+____exports.CHALLENGE_BOSSES = {
+    [Challenge.NULL] = BossID.MOM,
+    [Challenge.PITCH_BLACK] = BossID.MOM,
+    [Challenge.HIGH_BROW] = BossID.MOM,
+    [Challenge.HEAD_TRAUMA] = BossID.MOM,
+    [Challenge.DARKNESS_FALLS] = BossID.SATAN,
+    [Challenge.TANK] = BossID.MOM,
+    [Challenge.SOLAR_SYSTEM] = BossID.MOMS_HEART,
+    [Challenge.SUICIDE_KING] = BossID.ISAAC,
+    [Challenge.CAT_GOT_YOUR_TONGUE] = BossID.MOM,
+    [Challenge.DEMO_MAN] = BossID.MOMS_HEART,
+    [Challenge.CURSED] = BossID.MOM,
+    [Challenge.GLASS_CANNON] = BossID.SATAN,
+    [Challenge.WHEN_LIFE_GIVES_LEMONS] = BossID.MOM,
+    [Challenge.BEANS] = BossID.MOM,
+    [Challenge.ITS_IN_THE_CARDS] = BossID.MOM,
+    [Challenge.SLOW_ROLL] = BossID.MOM,
+    [Challenge.COMPUTER_SAVY] = BossID.MOM,
+    [Challenge.WAKA_WAKA] = BossID.MOM,
+    [Challenge.HOST] = BossID.MOM,
+    [Challenge.FAMILY_MAN] = BossID.ISAAC,
+    [Challenge.PURIST] = BossID.MOMS_HEART,
+    [Challenge.XXXXXXXXL] = BossID.MOMS_HEART,
+    [Challenge.SPEED] = BossID.MOMS_HEART,
+    [Challenge.BLUE_BOMBER] = BossID.SATAN,
+    [Challenge.PAY_TO_PLAY] = BossID.ISAAC,
+    [Challenge.HAVE_A_HEART] = BossID.MOMS_HEART,
+    [Challenge.I_RULE] = BossID.MEGA_SATAN,
+    [Challenge.BRAINS] = BossID.BLUE_BABY,
+    [Challenge.PRIDE_DAY] = BossID.MOMS_HEART,
+    [Challenge.ONANS_STREAK] = BossID.ISAAC,
+    [Challenge.GUARDIAN] = BossID.MOMS_HEART,
+    [Challenge.BACKASSWARDS] = BossID.MEGA_SATAN,
+    [Challenge.APRILS_FOOL] = BossID.MOMS_HEART,
+    [Challenge.POKEY_MANS] = BossID.ISAAC,
+    [Challenge.ULTRA_HARD] = BossID.MEGA_SATAN,
+    [Challenge.PONG] = BossID.BLUE_BABY,
+    [Challenge.SCAT_MAN] = BossID.MOM,
+    [Challenge.BLOODY_MARY] = BossID.SATAN,
+    [Challenge.BAPTISM_BY_FIRE] = BossID.SATAN,
+    [Challenge.ISAACS_AWAKENING] = BossID.MOTHER,
+    [Challenge.SEEING_DOUBLE] = BossID.MOMS_HEART,
+    [Challenge.PICA_RUN] = BossID.ISAAC,
+    [Challenge.HOT_POTATO] = BossID.SATAN,
+    [Challenge.CANTRIPPED] = BossID.MOM,
+    [Challenge.RED_REDEMPTION] = BossID.MOTHER,
+    [Challenge.DELETE_THIS] = BossID.BLUE_BABY
+}
+return ____exports

package/package.json

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

package/src/functions/challenges.ts

@@ -1,4 +1,12 @@
-import type { Challenge, PlayerType } from "isaac-typescript-definitions";
+import type {
+  BossID,
+  Challenge,
+  PlayerType,
+} from "isaac-typescript-definitions";
+import {
+  CHALLENGE_BOSSES,
+  DEFAULT_CHALLENGE_BOSS_ID,
+} from "../objects/challengeBosses";
 import {
   CHALLENGE_CHARACTERS,
   DEFAULT_CHALLENGE_CHARACTER,
@@ -8,6 +16,21 @@ import {
   DEFAULT_CHALLENGE_NAME,
 } from "../objects/challengeNames";
 
+/**
+ * Get the final boss of a challenge. This will only work for vanilla challenges.
+ *
+ * For modded challenges, `BossID.MOM` (6) will be returned.
+ *
+ * Note that for `Challenge.BACKASSWARDS` (31), this function will return `BossID.MEGA_SATAN` (55),
+ * but this is not actually the final boss. (There is no final boss for this challenge.)
+ */
+export function getChallengeBoss(challenge: Challenge): BossID {
+  const challengeBossID = CHALLENGE_BOSSES[challenge];
+  // Handle modded challenges.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return challengeBossID ?? DEFAULT_CHALLENGE_BOSS_ID;
+}
+
 /**
  * Get the starting character of a challenge. This will only work for vanilla challenges.
  *

package/src/objects/challengeBosses.ts

@@ -0,0 +1,57 @@
+import { BossID, Challenge } from "isaac-typescript-definitions";
+
+export const DEFAULT_CHALLENGE_BOSS_ID = BossID.MOM;
+
+/**
+ * Taken from the "challenges.xml" file.
+ *
+ * @see https://bindingofisaacrebirth.fandom.com/wiki/Challenges
+ */
+export const CHALLENGE_BOSSES = {
+  [Challenge.NULL]: BossID.MOM, // 0
+  [Challenge.PITCH_BLACK]: BossID.MOM, // 1
+  [Challenge.HIGH_BROW]: BossID.MOM, // 2
+  [Challenge.HEAD_TRAUMA]: BossID.MOM, // 3
+  [Challenge.DARKNESS_FALLS]: BossID.SATAN, // 4
+  [Challenge.TANK]: BossID.MOM, // 5
+  [Challenge.SOLAR_SYSTEM]: BossID.MOMS_HEART, // 6
+  [Challenge.SUICIDE_KING]: BossID.ISAAC, // 7
+  [Challenge.CAT_GOT_YOUR_TONGUE]: BossID.MOM, // 8
+  [Challenge.DEMO_MAN]: BossID.MOMS_HEART, // 9
+  [Challenge.CURSED]: BossID.MOM, // 10
+  [Challenge.GLASS_CANNON]: BossID.SATAN, // 11
+  [Challenge.WHEN_LIFE_GIVES_LEMONS]: BossID.MOM, // 12
+  [Challenge.BEANS]: BossID.MOM, // 13
+  [Challenge.ITS_IN_THE_CARDS]: BossID.MOM, // 14
+  [Challenge.SLOW_ROLL]: BossID.MOM, // 15
+  [Challenge.COMPUTER_SAVY]: BossID.MOM, // 16
+  [Challenge.WAKA_WAKA]: BossID.MOM, // 17
+  [Challenge.HOST]: BossID.MOM, // 18
+  [Challenge.FAMILY_MAN]: BossID.ISAAC, // 19
+  [Challenge.PURIST]: BossID.MOMS_HEART, // 20
+  [Challenge.XXXXXXXXL]: BossID.MOMS_HEART, // 21
+  [Challenge.SPEED]: BossID.MOMS_HEART, // 22
+  [Challenge.BLUE_BOMBER]: BossID.SATAN, // 23
+  [Challenge.PAY_TO_PLAY]: BossID.ISAAC, // 24
+  [Challenge.HAVE_A_HEART]: BossID.MOMS_HEART, // 25
+  [Challenge.I_RULE]: BossID.MEGA_SATAN, // 26
+  [Challenge.BRAINS]: BossID.BLUE_BABY, // 27
+  [Challenge.PRIDE_DAY]: BossID.MOMS_HEART, // 28
+  [Challenge.ONANS_STREAK]: BossID.ISAAC, // 29
+  [Challenge.GUARDIAN]: BossID.MOMS_HEART, // 30
+  [Challenge.BACKASSWARDS]: BossID.MEGA_SATAN, // 31
+  [Challenge.APRILS_FOOL]: BossID.MOMS_HEART, // 32
+  [Challenge.POKEY_MANS]: BossID.ISAAC, // 33
+  [Challenge.ULTRA_HARD]: BossID.MEGA_SATAN, // 34
+  [Challenge.PONG]: BossID.BLUE_BABY, // 35
+  [Challenge.SCAT_MAN]: BossID.MOM, // 36
+  [Challenge.BLOODY_MARY]: BossID.SATAN, // 37
+  [Challenge.BAPTISM_BY_FIRE]: BossID.SATAN, // 38
+  [Challenge.ISAACS_AWAKENING]: BossID.MOTHER, // 39
+  [Challenge.SEEING_DOUBLE]: BossID.MOMS_HEART, // 40
+  [Challenge.PICA_RUN]: BossID.ISAAC, // 41
+  [Challenge.HOT_POTATO]: BossID.SATAN, // 42
+  [Challenge.CANTRIPPED]: BossID.MOM, // 43
+  [Challenge.RED_REDEMPTION]: BossID.MOTHER, // 44
+  [Challenge.DELETE_THIS]: BossID.BLUE_BABY, // 45
+} as const satisfies Record<Challenge, BossID>;