isaacscript-common 84.2.5 → 84.3.0

package/dist/core/constantsFirstLast.js

@@ -88,7 +88,7 @@ exports.NUM_NORMAL_PILL_COLORS = exports.LAST_NORMAL_PILL_COLOR - exports.FIRST_
 // -------
 /** Equal to `PlayerType.ISAAC` (0). */
 exports.FIRST_CHARACTER = isaac_typescript_definitions_1.PlayerType.ISAAC;
-// It is not possible to determine "LAST_PLAYER_TYPE", since there is no associated config.
+// It is not possible to determine "LAST_CHARACTER", since there is no associated config.
 /** Calculated from the `PlayerType` enum. */
 exports.LAST_VANILLA_CHARACTER = (0, enums_1.getHighestEnumValue)(isaac_typescript_definitions_1.PlayerType);
 // ----------

package/dist/functions/characters.d.ts

@@ -1,36 +1,38 @@
 import type { CollectibleType, TrinketType } from "isaac-typescript-definitions";
 import { PlayerType } from "isaac-typescript-definitions";
+import { MAIN_CHARACTERS } from "../core/constants";
+type MainCharacter = (typeof MAIN_CHARACTERS)[number];
+/**
+ * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+ * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+ * Otherwise, returns false.
+ */
+export declare function canCharacterGetBlackHeartFromEternalHeart(character: PlayerType): boolean;
 /**
  * Helper function to determine if the given character can have red heart containers. Returns true
  * for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
  * though coin containers are not technically the same as red heart containers. Returns false for
  * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
  */
-export declare function characterCanHaveRedHearts(character: PlayerType): boolean;
+export declare function canCharacterHaveRedHearts(character: PlayerType): boolean;
 /**
  * Helper function to determine if the given character can have soul hearts. Returns true for
  * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
  * false for The Lost and Tainted Lost.
  */
-export declare function characterCanHaveSoulHearts(character: PlayerType): boolean;
+export declare function canCharacterHaveSoulHearts(character: PlayerType): boolean;
 /**
  * Helper function for determining whether the given character can take free Devil Deals. (e.g. The
  * Lost, Tainted Lost, etc.)
  */
-export declare function characterCanTakeFreeDevilDeals(character: PlayerType): boolean;
-/**
- * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
- * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
- * Otherwise, returns false.
- */
-export declare function characterGetsBlackHeartFromEternalHeart(character: PlayerType): boolean;
+export declare function canCharacterTakeFreeDevilDeals(character: PlayerType): boolean;
 /**
  * Helper function to determine if the specified character starts with an active item.
  *
  * For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
  * is considered to starts with the D6, but this is not the case on a brand new save file).
  */
-export declare function characterStartsWithActiveItem(character: PlayerType): boolean;
+export declare function doesCharacterStartWithActiveItem(character: PlayerType): boolean;
 /**
  * Helper function to get the numerical damage multiplier for a character.
  *
@@ -76,12 +78,24 @@ export declare function getCharacterStartingCollectibleTypes(character: PlayerTy
  * Note that this will return undefined for Eden and Tainted Eden.
  */
 export declare function getCharacterStartingTrinketType(character: PlayerType): TrinketType | undefined;
+/**
+ * Helper function to get the "main" version of the character. In other words, this is the character
+ * that selectable from the main menu (and has achievements related to completing the various bosses
+ * and so on).
+ *
+ * For example, the main character for `PlayerType.MAGDALENE` (1) is also `PlayerType.MAGDALENE`
+ * (1), but the main character for `PlayerType.LAZARUS_2` (11) would be `PlayerType.LAZARUS` (8).
+ *
+ * For `PlayerType.POSSESSOR` (-1) and modded characters, the same character will be returned.
+ */
+export declare function getMainCharacter(character: PlayerType): PlayerType | undefined;
 export declare function isFlyingCharacter(character: PlayerType): boolean;
 /**
  * Helper function to check if the provided character is one of the characters that are selectable
  * from the main menu (and have achievements related to completing the various bosses and so on).
  */
-export declare function isMainCharacter(character: PlayerType): boolean;
+export declare function isMainCharacter(character: PlayerType): character is MainCharacter;
 export declare function isModdedCharacter(character: PlayerType): boolean;
 export declare function isVanillaCharacter(character: PlayerType): boolean;
+export {};
 //# sourceMappingURL=characters.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"characters.d.ts","sourceRoot":"","sources":["../../src/functions/characters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,WAAW,EACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAqB1D;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEzE;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAE7E;AAED;;;;GAIG;AACH,wBAAgB,uCAAuC,CACrD,SAAS,EAAE,UAAU,GACpB,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAE5E;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAC1C,SAAS,EAAE,UAAU,EACrB,iBAAiB,UAAQ,GACxB,KAAK,CAMP;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAU5E;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,GAAG,CAsBzE;AAED,+FAA+F;AAC/F,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAM9D;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAG3E;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAClD,SAAS,EAAE,UAAU,GACpB,SAAS,eAAe,EAAE,CAE5B;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,UAAU,GACpB,WAAW,GAAG,SAAS,CAEzB;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEhE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAE9D;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEhE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEjE"}
+{"version":3,"file":"characters.d.ts","sourceRoot":"","sources":["../../src/functions/characters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,WAAW,EACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAqB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAevE,KAAK,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAOtD;;;;GAIG;AACH,wBAAgB,yCAAyC,CACvD,SAAS,EAAE,UAAU,GACpB,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEzE;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC9C,SAAS,EAAE,UAAU,GACpB,OAAO,CAET;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAC1C,SAAS,EAAE,UAAU,EACrB,iBAAiB,UAAQ,GACxB,KAAK,CAMP;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAU5E;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,GAAG,CAsBzE;AAED,+FAA+F;AAC/F,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAM9D;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAG3E;AAED;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAClD,SAAS,EAAE,UAAU,GACpB,SAAS,eAAe,EAAE,CAE5B;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,UAAU,GACpB,WAAW,GAAG,SAAS,CAEzB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,UAAU,GACpB,UAAU,GAAG,SAAS,CA8CxB;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEhE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,UAAU,GACpB,SAAS,IAAI,aAAa,CAE5B;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEhE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEjE"}

package/dist/functions/characters.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isVanillaCharacter = exports.isModdedCharacter = exports.isMainCharacter = exports.isFlyingCharacter = exports.getCharacterStartingTrinketType = exports.getCharacterStartingCollectibleTypes = exports.getCharacterSpritePNGFilePath = exports.getCharacterName = exports.getCharacterMaxHeartContainers = exports.getCharacterDeathAnimationName = exports.getCharacterDamageMultiplier = exports.characterStartsWithActiveItem = exports.characterGetsBlackHeartFromEternalHeart = exports.characterCanTakeFreeDevilDeals = exports.characterCanHaveSoulHearts = exports.characterCanHaveRedHearts = void 0;
+exports.isVanillaCharacter = exports.isModdedCharacter = exports.isMainCharacter = exports.isFlyingCharacter = exports.getMainCharacter = exports.getCharacterStartingTrinketType = exports.getCharacterStartingCollectibleTypes = exports.getCharacterSpritePNGFilePath = exports.getCharacterName = exports.getCharacterMaxHeartContainers = exports.getCharacterDeathAnimationName = exports.getCharacterDamageMultiplier = exports.doesCharacterStartWithActiveItem = exports.canCharacterTakeFreeDevilDeals = exports.canCharacterHaveSoulHearts = exports.canCharacterHaveRedHearts = exports.canCharacterGetBlackHeartFromEternalHeart = void 0;
 const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
 const constants_1 = require("../core/constants");
 const constantsFirstLast_1 = require("../core/constantsFirstLast");
@@ -19,52 +19,52 @@ const ReadonlySet_1 = require("../types/ReadonlySet");
 const FLYING_CHARACTERS_SET = new ReadonlySet_1.ReadonlySet(constants_1.FLYING_CHARACTERS);
 const MAIN_CHARACTERS_SET = new ReadonlySet_1.ReadonlySet(constants_1.MAIN_CHARACTERS);
 const PNG_PATH_PREFIX = "characters/costumes";
+/**
+ * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+ * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+ * Otherwise, returns false.
+ */
+function canCharacterGetBlackHeartFromEternalHeart(character) {
+    return charactersWithBlackHeartFromEternalHeartSet_1.CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET.has(character);
+}
+exports.canCharacterGetBlackHeartFromEternalHeart = canCharacterGetBlackHeartFromEternalHeart;
 /**
  * Helper function to determine if the given character can have red heart containers. Returns true
  * for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
  * though coin containers are not technically the same as red heart containers. Returns false for
  * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
  */
-function characterCanHaveRedHearts(character) {
+function canCharacterHaveRedHearts(character) {
     return !charactersWithNoRedHeartsSet_1.CHARACTERS_WITH_NO_RED_HEARTS_SET.has(character);
 }
-exports.characterCanHaveRedHearts = characterCanHaveRedHearts;
+exports.canCharacterHaveRedHearts = canCharacterHaveRedHearts;
 /**
  * Helper function to determine if the given character can have soul hearts. Returns true for
  * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
  * false for The Lost and Tainted Lost.
  */
-function characterCanHaveSoulHearts(character) {
+function canCharacterHaveSoulHearts(character) {
     return !charactersWithNoSoulHeartsSet_1.CHARACTERS_WITH_NO_SOUL_HEARTS_SET.has(character);
 }
-exports.characterCanHaveSoulHearts = characterCanHaveSoulHearts;
+exports.canCharacterHaveSoulHearts = canCharacterHaveSoulHearts;
 /**
  * Helper function for determining whether the given character can take free Devil Deals. (e.g. The
  * Lost, Tainted Lost, etc.)
  */
-function characterCanTakeFreeDevilDeals(character) {
+function canCharacterTakeFreeDevilDeals(character) {
     return charactersWithFreeDevilDealsSet_1.CHARACTERS_WITH_FREE_DEVIL_DEALS_SET.has(character);
 }
-exports.characterCanTakeFreeDevilDeals = characterCanTakeFreeDevilDeals;
-/**
- * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
- * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
- * Otherwise, returns false.
- */
-function characterGetsBlackHeartFromEternalHeart(character) {
-    return charactersWithBlackHeartFromEternalHeartSet_1.CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET.has(character);
-}
-exports.characterGetsBlackHeartFromEternalHeart = characterGetsBlackHeartFromEternalHeart;
+exports.canCharacterTakeFreeDevilDeals = canCharacterTakeFreeDevilDeals;
 /**
  * Helper function to determine if the specified character starts with an active item.
  *
  * For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
  * is considered to starts with the D6, but this is not the case on a brand new save file).
  */
-function characterStartsWithActiveItem(character) {
+function doesCharacterStartWithActiveItem(character) {
     return charactersThatStartWithAnActiveItemSet_1.CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET.has(character);
 }
-exports.characterStartsWithActiveItem = characterStartsWithActiveItem;
+exports.doesCharacterStartWithActiveItem = doesCharacterStartWithActiveItem;
 /**
  * Helper function to get the numerical damage multiplier for a character.
  *
@@ -160,6 +160,56 @@ function getCharacterStartingTrinketType(character) {
     return characterStartingTrinketTypes_1.CHARACTER_STARTING_TRINKET_TYPE[character];
 }
 exports.getCharacterStartingTrinketType = getCharacterStartingTrinketType;
+/**
+ * Helper function to get the "main" version of the character. In other words, this is the character
+ * that selectable from the main menu (and has achievements related to completing the various bosses
+ * and so on).
+ *
+ * For example, the main character for `PlayerType.MAGDALENE` (1) is also `PlayerType.MAGDALENE`
+ * (1), but the main character for `PlayerType.LAZARUS_2` (11) would be `PlayerType.LAZARUS` (8).
+ *
+ * For `PlayerType.POSSESSOR` (-1) and modded characters, the same character will be returned.
+ */
+function getMainCharacter(character) {
+    if (isMainCharacter(character) || isModdedCharacter(character)) {
+        return character;
+    }
+    switch (character) {
+        // -1
+        case isaac_typescript_definitions_1.PlayerType.POSSESSOR: {
+            return isaac_typescript_definitions_1.PlayerType.POSSESSOR;
+        }
+        // 11
+        case isaac_typescript_definitions_1.PlayerType.LAZARUS_2: {
+            return isaac_typescript_definitions_1.PlayerType.LAZARUS;
+        }
+        // 12
+        case isaac_typescript_definitions_1.PlayerType.DARK_JUDAS: {
+            return isaac_typescript_definitions_1.PlayerType.JUDAS;
+        }
+        // 17
+        case isaac_typescript_definitions_1.PlayerType.SOUL: {
+            return isaac_typescript_definitions_1.PlayerType.FORGOTTEN;
+        }
+        // 20
+        case isaac_typescript_definitions_1.PlayerType.ESAU: {
+            return isaac_typescript_definitions_1.PlayerType.JACOB;
+        }
+        // 38
+        case isaac_typescript_definitions_1.PlayerType.LAZARUS_2_B: {
+            return isaac_typescript_definitions_1.PlayerType.LAZARUS_2;
+        }
+        // 39
+        case isaac_typescript_definitions_1.PlayerType.JACOB_2_B: {
+            return isaac_typescript_definitions_1.PlayerType.JACOB_B;
+        }
+        // 40
+        case isaac_typescript_definitions_1.PlayerType.SOUL_B: {
+            return isaac_typescript_definitions_1.PlayerType.FORGOTTEN_B;
+        }
+    }
+}
+exports.getMainCharacter = getMainCharacter;
 function isFlyingCharacter(character) {
     return FLYING_CHARACTERS_SET.has(character);
 }

package/dist/functions/characters.lua

@@ -1,6 +1,7 @@
 local ____lualib = require("lualib_bundle")
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+local MAIN_CHARACTERS_SET
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
 local ____constants = require("core.constants")
@@ -32,6 +33,11 @@ local ____lostStyleCharactersSet = require("sets.lostStyleCharactersSet")
 local LOST_STYLE_CHARACTERS_SET = ____lostStyleCharactersSet.LOST_STYLE_CHARACTERS_SET
 local ____ReadonlySet = require("types.ReadonlySet")
 local ReadonlySet = ____ReadonlySet.ReadonlySet
+--- Helper function to check if the provided character is one of the characters that are selectable
+-- from the main menu (and have achievements related to completing the various bosses and so on).
+function ____exports.isMainCharacter(self, character)
+    return MAIN_CHARACTERS_SET:has(character)
+end
 function ____exports.isModdedCharacter(self, character)
     return not ____exports.isVanillaCharacter(nil, character)
 end
@@ -39,37 +45,37 @@ function ____exports.isVanillaCharacter(self, character)
     return character <= LAST_VANILLA_CHARACTER
 end
 local FLYING_CHARACTERS_SET = __TS__New(ReadonlySet, FLYING_CHARACTERS)
-local MAIN_CHARACTERS_SET = __TS__New(ReadonlySet, MAIN_CHARACTERS)
+MAIN_CHARACTERS_SET = __TS__New(ReadonlySet, MAIN_CHARACTERS)
 local PNG_PATH_PREFIX = "characters/costumes"
+--- Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+-- but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+-- Otherwise, returns false.
+function ____exports.canCharacterGetBlackHeartFromEternalHeart(self, character)
+    return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET:has(character)
+end
 --- Helper function to determine if the given character can have red heart containers. Returns true
 -- for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
 -- though coin containers are not technically the same as red heart containers. Returns false for
 -- characters like Blue Baby. Returns false for The Lost and Tainted Lost.
-function ____exports.characterCanHaveRedHearts(self, character)
+function ____exports.canCharacterHaveRedHearts(self, character)
     return not CHARACTERS_WITH_NO_RED_HEARTS_SET:has(character)
 end
 --- Helper function to determine if the given character can have soul hearts. Returns true for
 -- characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
 -- false for The Lost and Tainted Lost.
-function ____exports.characterCanHaveSoulHearts(self, character)
+function ____exports.canCharacterHaveSoulHearts(self, character)
     return not CHARACTERS_WITH_NO_SOUL_HEARTS_SET:has(character)
 end
 --- Helper function for determining whether the given character can take free Devil Deals. (e.g. The
 -- Lost, Tainted Lost, etc.)
-function ____exports.characterCanTakeFreeDevilDeals(self, character)
+function ____exports.canCharacterTakeFreeDevilDeals(self, character)
     return CHARACTERS_WITH_FREE_DEVIL_DEALS_SET:has(character)
 end
---- Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
--- but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
--- Otherwise, returns false.
-function ____exports.characterGetsBlackHeartFromEternalHeart(self, character)
-    return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET:has(character)
-end
 --- Helper function to determine if the specified character starts with an active item.
 -- 
 -- For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
 -- is considered to starts with the D6, but this is not the case on a brand new save file).
-function ____exports.characterStartsWithActiveItem(self, character)
+function ____exports.doesCharacterStartWithActiveItem(self, character)
     return CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET:has(character)
 end
 --- Helper function to get the numerical damage multiplier for a character.
@@ -147,12 +153,71 @@ end
 function ____exports.getCharacterStartingTrinketType(self, character)
     return CHARACTER_STARTING_TRINKET_TYPE[character]
 end
+--- Helper function to get the "main" version of the character. In other words, this is the character
+-- that selectable from the main menu (and has achievements related to completing the various bosses
+-- and so on).
+-- 
+-- For example, the main character for `PlayerType.MAGDALENE` (1) is also `PlayerType.MAGDALENE`
+-- (1), but the main character for `PlayerType.LAZARUS_2` (11) would be `PlayerType.LAZARUS` (8).
+-- 
+-- For `PlayerType.POSSESSOR` (-1) and modded characters, the same character will be returned.
+function ____exports.getMainCharacter(self, character)
+    if ____exports.isMainCharacter(nil, character) or ____exports.isModdedCharacter(nil, character) then
+        return character
+    end
+    repeat
+        local ____switch24 = character
+        local ____cond24 = ____switch24 == PlayerType.POSSESSOR
+        if ____cond24 then
+            do
+                return PlayerType.POSSESSOR
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.LAZARUS_2
+        if ____cond24 then
+            do
+                return PlayerType.LAZARUS
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.DARK_JUDAS
+        if ____cond24 then
+            do
+                return PlayerType.JUDAS
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.SOUL
+        if ____cond24 then
+            do
+                return PlayerType.FORGOTTEN
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.ESAU
+        if ____cond24 then
+            do
+                return PlayerType.JACOB
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.LAZARUS_2_B
+        if ____cond24 then
+            do
+                return PlayerType.LAZARUS_2
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.JACOB_2_B
+        if ____cond24 then
+            do
+                return PlayerType.JACOB_B
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.SOUL_B
+        if ____cond24 then
+            do
+                return PlayerType.FORGOTTEN_B
+            end
+        end
+    until true
+end
 function ____exports.isFlyingCharacter(self, character)
     return FLYING_CHARACTERS_SET:has(character)
 end
---- Helper function to check if the provided character is one of the characters that are selectable
--- from the main menu (and have achievements related to completing the various bosses and so on).
-function ____exports.isMainCharacter(self, character)
-    return MAIN_CHARACTERS_SET:has(character)
-end
 return ____exports

package/dist/index.rollup.d.ts

@@ -1353,6 +1353,34 @@ export declare function Callback<T extends ModCallback>(modCallback: T, ...optio
  */
 export declare function CallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>): <Class extends ModFeature, Fn extends AddCallbackParametersCustom[T][0]>(target: Class, propertyKey: string, _descriptor: TypedPropertyDescriptor<Fn>) => void;
 
+/**
+ * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+ * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+ * Otherwise, returns false.
+ */
+export declare function canCharacterGetBlackHeartFromEternalHeart(character: PlayerType): boolean;
+
+/**
+ * Helper function to determine if the given character can have red heart containers. Returns true
+ * for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
+ * though coin containers are not technically the same as red heart containers. Returns false for
+ * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
+ */
+export declare function canCharacterHaveRedHearts(character: PlayerType): boolean;
+
+/**
+ * Helper function to determine if the given character can have soul hearts. Returns true for
+ * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
+ * false for The Lost and Tainted Lost.
+ */
+export declare function canCharacterHaveSoulHearts(character: PlayerType): boolean;
+
+/**
+ * Helper function for determining whether the given character can take free Devil Deals. (e.g. The
+ * Lost, Tainted Lost, etc.)
+ */
+export declare function canCharacterTakeFreeDevilDeals(character: PlayerType): boolean;
+
 /**
  * Helper function to see if the provided player can pick up an eternal heart. (If a player already
  * has an eternal heart and full heart containers, they are not able to pick up any additional
@@ -1388,34 +1416,6 @@ export declare function changeRoom(roomGridIndex: int): void;
 /** Maps character names to the values of the `PlayerType` enum. */
 export declare const CHARACTER_NAME_TO_TYPE_MAP: ReadonlyMap<string, PlayerType>;
 
-/**
- * Helper function to determine if the given character can have red heart containers. Returns true
- * for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
- * though coin containers are not technically the same as red heart containers. Returns false for
- * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
- */
-export declare function characterCanHaveRedHearts(character: PlayerType): boolean;
-
-/**
- * Helper function to determine if the given character can have soul hearts. Returns true for
- * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
- * false for The Lost and Tainted Lost.
- */
-export declare function characterCanHaveSoulHearts(character: PlayerType): boolean;
-
-/**
- * Helper function for determining whether the given character can take free Devil Deals. (e.g. The
- * Lost, Tainted Lost, etc.)
- */
-export declare function characterCanTakeFreeDevilDeals(character: PlayerType): boolean;
-
-/**
- * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
- * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
- * Otherwise, returns false.
- */
-export declare function characterGetsBlackHeartFromEternalHeart(character: PlayerType): boolean;
-
 declare class CharacterHealthConversion extends Feature {
     private readonly characterHealthReplacementMap;
     private readonly prePickupCollisionHeart;
@@ -1434,14 +1434,6 @@ declare class CharacterHealthConversion extends Feature {
     registerCharacterHealthConversion(playerType: PlayerType, conversionHeartSubType: ConversionHeartSubType): void;
 }
 
-/**
- * Helper function to determine if the specified character starts with an active item.
- *
- * For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
- * is considered to starts with the D6, but this is not the case on a brand new save file).
- */
-export declare function characterStartsWithActiveItem(character: PlayerType): boolean;
-
 /** Easily create custom characters that have base stats different from that of Isaac. */
 declare class CharacterStats extends Feature {
     private readonly charactersStatMap;
@@ -3962,6 +3954,14 @@ export declare const DISTANCE_OF_GRID_TILE = 40;
  */
 export declare function doesAnyEntityExist(entityTypes: readonly EntityType[] | ReadonlySet<EntityType>, ignoreFriendly?: boolean): boolean;
 
+/**
+ * Helper function to determine if the specified character starts with an active item.
+ *
+ * For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
+ * is considered to starts with the D6, but this is not the case on a brand new save file).
+ */
+export declare function doesCharacterStartWithActiveItem(character: PlayerType): boolean;
+
 /**
  * Helper function to check if one or more of a specific kind of entity is present in the current
  * room. It uses the `countEntities` helper function to determine this.
@@ -6345,6 +6345,18 @@ export declare function getLowestArrayElement(array: readonly number[]): number
  */
 export declare function getLowestEnumValue<T extends TranspiledEnum>(transpiledEnum: T): T[keyof T];
 
+/**
+ * Helper function to get the "main" version of the character. In other words, this is the character
+ * that selectable from the main menu (and has achievements related to completing the various bosses
+ * and so on).
+ *
+ * For example, the main character for `PlayerType.MAGDALENE` (1) is also `PlayerType.MAGDALENE`
+ * (1), but the main character for `PlayerType.LAZARUS_2` (11) would be `PlayerType.LAZARUS` (8).
+ *
+ * For `PlayerType.POSSESSOR` (-1) and modded characters, the same character will be returned.
+ */
+export declare function getMainCharacter(character: PlayerType): PlayerType | undefined;
+
 /**
  * Helper function to get the closest key from a map based on partial search text. (It only searches
  * through the keys, not the values.)
@@ -9766,7 +9778,7 @@ export declare function isLuaDebugEnabled(): boolean;
  * Helper function to check if the provided character is one of the characters that are selectable
  * from the main menu (and have achievements related to completing the various bosses and so on).
  */
-export declare function isMainCharacter(character: PlayerType): boolean;
+export declare function isMainCharacter(character: PlayerType): character is MainCharacter;
 
 /**
  * Helper function to check if the provided door is the one that leads to the Mega Satan Boss Room.
@@ -10972,6 +10984,8 @@ export declare type LowercaseKeys<T> = StartsWithLowercase<keyof T>;
  */
 export declare const MAIN_CHARACTERS: readonly [PlayerType.ISAAC, PlayerType.MAGDALENE, PlayerType.CAIN, PlayerType.JUDAS, PlayerType.BLUE_BABY, PlayerType.EVE, PlayerType.SAMSON, PlayerType.AZAZEL, PlayerType.LAZARUS, PlayerType.EDEN, PlayerType.LOST, PlayerType.LILITH, PlayerType.KEEPER, PlayerType.APOLLYON, PlayerType.FORGOTTEN, PlayerType.BETHANY, PlayerType.JACOB, PlayerType.ISAAC_B, PlayerType.MAGDALENE_B, PlayerType.CAIN_B, PlayerType.JUDAS_B, PlayerType.BLUE_BABY_B, PlayerType.EVE_B, PlayerType.SAMSON_B, PlayerType.AZAZEL_B, PlayerType.LAZARUS_B, PlayerType.EDEN_B, PlayerType.LOST_B, PlayerType.LILITH_B, PlayerType.KEEPER_B, PlayerType.APOLLYON_B, PlayerType.FORGOTTEN_B, PlayerType.BETHANY_B, PlayerType.JACOB_B];
 
+declare type MainCharacter = (typeof MAIN_CHARACTERS)[number];
+
 /**
  * Helper function for non-TypeScript users to convert all of the elements in an array to something
  * else.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 84.2.4
+isaacscript-common 84.2.5
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -22287,6 +22287,7 @@ return ____exports
 local ____lualib = require("lualib_bundle")
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+local MAIN_CHARACTERS_SET
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.index")
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
 local ____constants = require("core.constants")
@@ -22318,6 +22319,11 @@ local ____lostStyleCharactersSet = require("sets.lostStyleCharactersSet")
 local LOST_STYLE_CHARACTERS_SET = ____lostStyleCharactersSet.LOST_STYLE_CHARACTERS_SET
 local ____ReadonlySet = require("types.ReadonlySet")
 local ReadonlySet = ____ReadonlySet.ReadonlySet
+--- Helper function to check if the provided character is one of the characters that are selectable
+-- from the main menu (and have achievements related to completing the various bosses and so on).
+function ____exports.isMainCharacter(self, character)
+    return MAIN_CHARACTERS_SET:has(character)
+end
 function ____exports.isModdedCharacter(self, character)
     return not ____exports.isVanillaCharacter(nil, character)
 end
@@ -22325,37 +22331,37 @@ function ____exports.isVanillaCharacter(self, character)
     return character <= LAST_VANILLA_CHARACTER
 end
 local FLYING_CHARACTERS_SET = __TS__New(ReadonlySet, FLYING_CHARACTERS)
-local MAIN_CHARACTERS_SET = __TS__New(ReadonlySet, MAIN_CHARACTERS)
+MAIN_CHARACTERS_SET = __TS__New(ReadonlySet, MAIN_CHARACTERS)
 local PNG_PATH_PREFIX = "characters/costumes"
+--- Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+-- but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+-- Otherwise, returns false.
+function ____exports.canCharacterGetBlackHeartFromEternalHeart(self, character)
+    return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET:has(character)
+end
 --- Helper function to determine if the given character can have red heart containers. Returns true
 -- for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
 -- though coin containers are not technically the same as red heart containers. Returns false for
 -- characters like Blue Baby. Returns false for The Lost and Tainted Lost.
-function ____exports.characterCanHaveRedHearts(self, character)
+function ____exports.canCharacterHaveRedHearts(self, character)
     return not CHARACTERS_WITH_NO_RED_HEARTS_SET:has(character)
 end
 --- Helper function to determine if the given character can have soul hearts. Returns true for
 -- characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
 -- false for The Lost and Tainted Lost.
-function ____exports.characterCanHaveSoulHearts(self, character)
+function ____exports.canCharacterHaveSoulHearts(self, character)
     return not CHARACTERS_WITH_NO_SOUL_HEARTS_SET:has(character)
 end
 --- Helper function for determining whether the given character can take free Devil Deals. (e.g. The
 -- Lost, Tainted Lost, etc.)
-function ____exports.characterCanTakeFreeDevilDeals(self, character)
+function ____exports.canCharacterTakeFreeDevilDeals(self, character)
     return CHARACTERS_WITH_FREE_DEVIL_DEALS_SET:has(character)
 end
---- Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
--- but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
--- Otherwise, returns false.
-function ____exports.characterGetsBlackHeartFromEternalHeart(self, character)
-    return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET:has(character)
-end
 --- Helper function to determine if the specified character starts with an active item.
 -- 
 -- For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
 -- is considered to starts with the D6, but this is not the case on a brand new save file).
-function ____exports.characterStartsWithActiveItem(self, character)
+function ____exports.doesCharacterStartWithActiveItem(self, character)
     return CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET:has(character)
 end
 --- Helper function to get the numerical damage multiplier for a character.
@@ -22433,14 +22439,73 @@ end
 function ____exports.getCharacterStartingTrinketType(self, character)
     return CHARACTER_STARTING_TRINKET_TYPE[character]
 end
+--- Helper function to get the "main" version of the character. In other words, this is the character
+-- that selectable from the main menu (and has achievements related to completing the various bosses
+-- and so on).
+-- 
+-- For example, the main character for `PlayerType.MAGDALENE` (1) is also `PlayerType.MAGDALENE`
+-- (1), but the main character for `PlayerType.LAZARUS_2` (11) would be `PlayerType.LAZARUS` (8).
+-- 
+-- For `PlayerType.POSSESSOR` (-1) and modded characters, the same character will be returned.
+function ____exports.getMainCharacter(self, character)
+    if ____exports.isMainCharacter(nil, character) or ____exports.isModdedCharacter(nil, character) then
+        return character
+    end
+    repeat
+        local ____switch24 = character
+        local ____cond24 = ____switch24 == PlayerType.POSSESSOR
+        if ____cond24 then
+            do
+                return PlayerType.POSSESSOR
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.LAZARUS_2
+        if ____cond24 then
+            do
+                return PlayerType.LAZARUS
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.DARK_JUDAS
+        if ____cond24 then
+            do
+                return PlayerType.JUDAS
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.SOUL
+        if ____cond24 then
+            do
+                return PlayerType.FORGOTTEN
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.ESAU
+        if ____cond24 then
+            do
+                return PlayerType.JACOB
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.LAZARUS_2_B
+        if ____cond24 then
+            do
+                return PlayerType.LAZARUS_2
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.JACOB_2_B
+        if ____cond24 then
+            do
+                return PlayerType.JACOB_B
+            end
+        end
+        ____cond24 = ____cond24 or ____switch24 == PlayerType.SOUL_B
+        if ____cond24 then
+            do
+                return PlayerType.FORGOTTEN_B
+            end
+        end
+    until true
+end
 function ____exports.isFlyingCharacter(self, character)
     return FLYING_CHARACTERS_SET:has(character)
 end
---- Helper function to check if the provided character is one of the characters that are selectable
--- from the main menu (and have achievements related to completing the various bosses and so on).
-function ____exports.isMainCharacter(self, character)
-    return MAIN_CHARACTERS_SET:has(character)
-end
 return ____exports
  end,
 ["functions.players"] = function(...) 

package/package.json

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

package/src/core/constantsFirstLast.ts

@@ -121,7 +121,7 @@ export const NUM_NORMAL_PILL_COLORS =
 /** Equal to `PlayerType.ISAAC` (0). */
 export const FIRST_CHARACTER = PlayerType.ISAAC;
 
-// It is not possible to determine "LAST_PLAYER_TYPE", since there is no associated config.
+// It is not possible to determine "LAST_CHARACTER", since there is no associated config.
 
 /** Calculated from the `PlayerType` enum. */
 export const LAST_VANILLA_CHARACTER = getHighestEnumValue(PlayerType);

package/src/functions/characters.ts

@@ -18,18 +18,31 @@ import { CHARACTERS_WITH_NO_SOUL_HEARTS_SET } from "../sets/charactersWithNoSoul
 import { LOST_STYLE_CHARACTERS_SET } from "../sets/lostStyleCharactersSet";
 import { ReadonlySet } from "../types/ReadonlySet";
 
+type MainCharacter = (typeof MAIN_CHARACTERS)[number];
+
 const FLYING_CHARACTERS_SET = new ReadonlySet<PlayerType>(FLYING_CHARACTERS);
 const MAIN_CHARACTERS_SET = new ReadonlySet<PlayerType>(MAIN_CHARACTERS);
 
 const PNG_PATH_PREFIX = "characters/costumes";
 
+/**
+ * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+ * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+ * Otherwise, returns false.
+ */
+export function canCharacterGetBlackHeartFromEternalHeart(
+  character: PlayerType,
+): boolean {
+  return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET.has(character);
+}
+
 /**
  * Helper function to determine if the given character can have red heart containers. Returns true
  * for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
  * though coin containers are not technically the same as red heart containers. Returns false for
  * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
  */
-export function characterCanHaveRedHearts(character: PlayerType): boolean {
+export function canCharacterHaveRedHearts(character: PlayerType): boolean {
   return !CHARACTERS_WITH_NO_RED_HEARTS_SET.has(character);
 }
 
@@ -38,7 +51,7 @@ export function characterCanHaveRedHearts(character: PlayerType): boolean {
  * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
  * false for The Lost and Tainted Lost.
  */
-export function characterCanHaveSoulHearts(character: PlayerType): boolean {
+export function canCharacterHaveSoulHearts(character: PlayerType): boolean {
   return !CHARACTERS_WITH_NO_SOUL_HEARTS_SET.has(character);
 }
 
@@ -46,28 +59,19 @@ export function characterCanHaveSoulHearts(character: PlayerType): boolean {
  * Helper function for determining whether the given character can take free Devil Deals. (e.g. The
  * Lost, Tainted Lost, etc.)
  */
-export function characterCanTakeFreeDevilDeals(character: PlayerType): boolean {
+export function canCharacterTakeFreeDevilDeals(character: PlayerType): boolean {
   return CHARACTERS_WITH_FREE_DEVIL_DEALS_SET.has(character);
 }
 
-/**
- * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
- * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
- * Otherwise, returns false.
- */
-export function characterGetsBlackHeartFromEternalHeart(
-  character: PlayerType,
-): boolean {
-  return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET.has(character);
-}
-
 /**
  * Helper function to determine if the specified character starts with an active item.
  *
  * For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
  * is considered to starts with the D6, but this is not the case on a brand new save file).
  */
-export function characterStartsWithActiveItem(character: PlayerType): boolean {
+export function doesCharacterStartWithActiveItem(
+  character: PlayerType,
+): boolean {
   return CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET.has(character);
 }
 
@@ -181,6 +185,66 @@ export function getCharacterStartingTrinketType(
   return CHARACTER_STARTING_TRINKET_TYPE[character];
 }
 
+/**
+ * Helper function to get the "main" version of the character. In other words, this is the character
+ * that selectable from the main menu (and has achievements related to completing the various bosses
+ * and so on).
+ *
+ * For example, the main character for `PlayerType.MAGDALENE` (1) is also `PlayerType.MAGDALENE`
+ * (1), but the main character for `PlayerType.LAZARUS_2` (11) would be `PlayerType.LAZARUS` (8).
+ *
+ * For `PlayerType.POSSESSOR` (-1) and modded characters, the same character will be returned.
+ */
+export function getMainCharacter(
+  character: PlayerType,
+): PlayerType | undefined {
+  if (isMainCharacter(character) || isModdedCharacter(character)) {
+    return character;
+  }
+
+  switch (character) {
+    // -1
+    case PlayerType.POSSESSOR: {
+      return PlayerType.POSSESSOR;
+    }
+
+    // 11
+    case PlayerType.LAZARUS_2: {
+      return PlayerType.LAZARUS;
+    }
+
+    // 12
+    case PlayerType.DARK_JUDAS: {
+      return PlayerType.JUDAS;
+    }
+
+    // 17
+    case PlayerType.SOUL: {
+      return PlayerType.FORGOTTEN;
+    }
+
+    // 20
+    case PlayerType.ESAU: {
+      return PlayerType.JACOB;
+    }
+
+    // 38
+    case PlayerType.LAZARUS_2_B: {
+      return PlayerType.LAZARUS_2;
+    }
+
+    // 39
+    case PlayerType.JACOB_2_B: {
+      return PlayerType.JACOB_B;
+    }
+
+    // 40
+    case PlayerType.SOUL_B: {
+      return PlayerType.FORGOTTEN_B;
+    }
+  }
+}
+
 export function isFlyingCharacter(character: PlayerType): boolean {
   return FLYING_CHARACTERS_SET.has(character);
 }
@@ -189,7 +253,9 @@ export function isFlyingCharacter(character: PlayerType): boolean {
  * Helper function to check if the provided character is one of the characters that are selectable
  * from the main menu (and have achievements related to completing the various bosses and so on).
  */
-export function isMainCharacter(character: PlayerType): boolean {
+export function isMainCharacter(
+  character: PlayerType,
+): character is MainCharacter {
   return MAIN_CHARACTERS_SET.has(character);
 }