isaacscript-common 84.2.4 → 84.3.0

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 84.2.3
+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(...)