isaacscript-common 51.0.0 → 51.1.0

package/dist/index.rollup.d.ts

@@ -4971,6 +4971,14 @@ export declare function getCharacterName(character: PlayerType): string;
 /** Helper function to get an array containing the characters of all of the current players. */
 export declare function getCharacters(): PlayerType[];
 
+/**
+ * Helper function to get the path to the sprite for a particular character.
+ *
+ * For example, the file path for `PlayerType.ISAAC` is
+ * "characters/costumes/character_001_isaac.png".
+ */
+export declare function getCharacterSpritePNGFilePath(character: PlayerType): string;
+
 /**
  * Helper function to get the collectibles that are granted to a particular character at the
  * beginning of a run.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 51.0.0
+isaacscript-common 51.1.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -19152,6 +19152,56 @@ ____exports.CHARACTER_NAMES = {
     [PlayerType.JACOB_2_B] = "Dead Tainted Jacob",
     [PlayerType.SOUL_B] = "Tainted Soul"
 }
+return ____exports
+ end,
+["src.objects.characterSpritePNGFileNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+____exports.CHARACTER_SPRITE_PNG_FILE_NAMES = {
+    [PlayerType.POSSESSOR] = "character_001_isaac.png",
+    [PlayerType.ISAAC] = "character_001_isaac.png",
+    [PlayerType.MAGDALENE] = "character_002_magdalene.png",
+    [PlayerType.CAIN] = "character_003_cain.png",
+    [PlayerType.JUDAS] = "character_004_judas.png",
+    [PlayerType.BLUE_BABY] = "character_006_bluebaby.png",
+    [PlayerType.EVE] = "character_005_eve.png",
+    [PlayerType.SAMSON] = "character_007_samson.png",
+    [PlayerType.AZAZEL] = "character_008_azazel.png",
+    [PlayerType.LAZARUS] = "character_009_lazarus.png",
+    [PlayerType.EDEN] = "character_009_eden.png",
+    [PlayerType.LOST] = "character_012_thelost.png",
+    [PlayerType.LAZARUS_2] = "character_010_lazarus2.png",
+    [PlayerType.DARK_JUDAS] = "character_013_blackjudas.png",
+    [PlayerType.LILITH] = "character_014_lilith.png",
+    [PlayerType.KEEPER] = "character_015_keeper.png",
+    [PlayerType.APOLLYON] = "character_016_apollyon.png",
+    [PlayerType.FORGOTTEN] = "character_017_theforgotten.png",
+    [PlayerType.SOUL] = "character_018_thesoul.png",
+    [PlayerType.BETHANY] = "character_001x_bethany.png",
+    [PlayerType.JACOB] = "character_002x_jacob.png",
+    [PlayerType.ESAU] = "character_003x_esau.png",
+    [PlayerType.ISAAC_B] = "character_001b_isaac.png",
+    [PlayerType.MAGDALENE_B] = "character_002b_magdalene.png",
+    [PlayerType.CAIN_B] = "character_003b_cain.png",
+    [PlayerType.JUDAS_B] = "character_004b_judas.png",
+    [PlayerType.BLUE_BABY_B] = "character_005b_bluebaby.png",
+    [PlayerType.EVE_B] = "character_006b_eve.png",
+    [PlayerType.SAMSON_B] = "character_007b_samson.png",
+    [PlayerType.AZAZEL_B] = "character_008b_azazel.png",
+    [PlayerType.LAZARUS_B] = "character_009b_lazarus.png",
+    [PlayerType.EDEN_B] = "character_009_eden.png",
+    [PlayerType.LOST_B] = "character_012b_thelost.png",
+    [PlayerType.LILITH_B] = "character_014b_lilith.png",
+    [PlayerType.KEEPER_B] = "character_015b_keeper.png",
+    [PlayerType.APOLLYON_B] = "character_016b_apollyon.png",
+    [PlayerType.FORGOTTEN_B] = "character_016b_theforgotten.png",
+    [PlayerType.BETHANY_B] = "character_018b_bethany.png",
+    [PlayerType.JACOB_B] = "character_019b_jacob.png",
+    [PlayerType.LAZARUS_2_B] = "character_009b_lazarus2.png",
+    [PlayerType.JACOB_2_B] = "character_019b_jacob2.png",
+    [PlayerType.SOUL_B] = "character_017b_thesoul.png"
+}
 return ____exports
  end,
 ["src.objects.characterStartingCollectibleTypes"] = function(...) 
@@ -19370,6 +19420,8 @@ local ____characterDamageMultipliers = require("src.objects.characterDamageMulti
 local CHARACTER_DAMAGE_MULTIPLIERS = ____characterDamageMultipliers.CHARACTER_DAMAGE_MULTIPLIERS
 local ____characterNames = require("src.objects.characterNames")
 local CHARACTER_NAMES = ____characterNames.CHARACTER_NAMES
+local ____characterSpritePNGFileNames = require("src.objects.characterSpritePNGFileNames")
+local CHARACTER_SPRITE_PNG_FILE_NAMES = ____characterSpritePNGFileNames.CHARACTER_SPRITE_PNG_FILE_NAMES
 local ____characterStartingCollectibleTypes = require("src.objects.characterStartingCollectibleTypes")
 local CHARACTER_STARTING_COLLECTIBLE_TYPES = ____characterStartingCollectibleTypes.CHARACTER_STARTING_COLLECTIBLE_TYPES
 local ____characterStartingTrinketTypes = require("src.objects.characterStartingTrinketTypes")
@@ -19396,6 +19448,7 @@ function ____exports.isVanillaCharacter(self, character)
 end
 local FLYING_CHARACTERS_SET = __TS__New(ReadonlySet, FLYING_CHARACTERS)
 local MAIN_CHARACTERS_SET = __TS__New(ReadonlySet, MAIN_CHARACTERS)
+local PNG_PATH_PREFIX = "characters/costumes"
 function ____exports.characterCanHaveRedHearts(self, character)
     return not CHARACTERS_WITH_NO_RED_HEARTS_SET:has(character)
 end
@@ -19450,6 +19503,10 @@ function ____exports.getCharacterName(self, character)
     end
     return CHARACTER_NAMES[character]
 end
+function ____exports.getCharacterSpritePNGFilePath(self, character)
+    local fileName = CHARACTER_SPRITE_PNG_FILE_NAMES[character]
+    return (PNG_PATH_PREFIX .. "/") .. fileName
+end
 function ____exports.getCharacterStartingCollectibleTypes(self, character)
     return CHARACTER_STARTING_COLLECTIBLE_TYPES[character]
 end
@@ -44762,19 +44819,19 @@ local ____playerPortraitPNGFileNames = require("src.objects.playerPortraitPNGFil
 local PLAYER_PORTRAIT_PNG_FILE_NAMES = ____playerPortraitPNGFileNames.PLAYER_PORTRAIT_PNG_FILE_NAMES
 local PNG_PATH_PREFIX = "gfx/ui/boss"
 local PLAYER_PORTRAIT_PNG_PATH_PREFIX = "gfx/ui/stage"
-function ____exports.getBossNameFilePath(self, bossID)
+function ____exports.getBossNamePNGFilePath(self, bossID)
     local fileName = BOSS_NAME_PNG_FILE_NAMES[bossID]
     return (PNG_PATH_PREFIX .. "/") .. fileName
 end
-function ____exports.getBossPortraitFilePath(self, bossID)
+function ____exports.getBossPortraitPNGFilePath(self, bossID)
     local fileName = BOSS_PORTRAIT_PNG_FILE_NAMES[bossID]
     return (PNG_PATH_PREFIX .. "/") .. fileName
 end
-function ____exports.getCharacterNameFilePath(self, character)
+function ____exports.getCharacterNamePNGFilePath(self, character)
     local fileName = PLAYER_NAME_PNG_FILE_NAMES[character]
     return (PNG_PATH_PREFIX .. "/") .. tostring(fileName)
 end
-function ____exports.getCharacterPortraitFilePath(self, character)
+function ____exports.getCharacterPortraitPNGFilePath(self, character)
     local fileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[character]
     return (PLAYER_PORTRAIT_PNG_PATH_PREFIX .. "/") .. tostring(fileName)
 end
@@ -44888,10 +44945,10 @@ local getScreenCenterPos = ____ui.getScreenCenterPos
 local ____utils = require("src.functions.utils")
 local eRange = ____utils.eRange
 local ____versusScreen = require("src.functions.versusScreen")
-local getBossNameFilePath = ____versusScreen.getBossNameFilePath
-local getBossPortraitFilePath = ____versusScreen.getBossPortraitFilePath
-local getCharacterNameFilePath = ____versusScreen.getCharacterNameFilePath
-local getCharacterPortraitFilePath = ____versusScreen.getCharacterPortraitFilePath
+local getBossNamePNGFilePath = ____versusScreen.getBossNamePNGFilePath
+local getBossPortraitPNGFilePath = ____versusScreen.getBossPortraitPNGFilePath
+local getCharacterNamePNGFilePath = ____versusScreen.getCharacterNamePNGFilePath
+local getCharacterPortraitPNGFilePath = ____versusScreen.getCharacterPortraitPNGFilePath
 local ____versusScreenBackgroundColors = require("src.objects.versusScreenBackgroundColors")
 local VERSUS_SCREEN_BACKGROUND_COLORS = ____versusScreenBackgroundColors.VERSUS_SCREEN_BACKGROUND_COLORS
 local ____versusScreenDirtSpotColors = require("src.objects.versusScreenDirtSpotColors")
@@ -44918,8 +44975,8 @@ function getPlayerPNGPaths(self)
     if character == PlayerType.POSSESSOR then
         error("Failed to get the player PNG paths since they are a possessor.")
     end
-    local namePNGPath = getCharacterNameFilePath(nil, character)
-    local portraitPNGPath = getCharacterPortraitFilePath(nil, character)
+    local namePNGPath = getCharacterNamePNGFilePath(nil, character)
+    local portraitPNGPath = getCharacterPortraitPNGFilePath(nil, character)
     return {namePNGPath = namePNGPath, portraitPNGPath = portraitPNGPath}
 end
 function getBossPNGPaths(self, customStage)
@@ -44931,13 +44988,13 @@ function getBossPNGPaths(self, customStage)
     local firstBoss = bosses[1]
     local bossID = firstBoss == nil and 0 or firstBoss:GetBossID()
     if bossID == 0 then
-        local questionMarkPath = getBossNameFilePath(nil, BossID.BLUE_BABY)
+        local questionMarkPath = getBossNamePNGFilePath(nil, BossID.BLUE_BABY)
         local namePNGPath = questionMarkPath
         local portraitPNGPath = questionMarkPath
         return {namePNGPath = namePNGPath, portraitPNGPath = portraitPNGPath}
     end
-    local namePNGPath = getBossNameFilePath(nil, bossID)
-    local portraitPNGPath = getBossPortraitFilePath(nil, bossID)
+    local namePNGPath = getBossNamePNGFilePath(nil, bossID)
+    local portraitPNGPath = getBossPortraitPNGFilePath(nil, bossID)
     return {namePNGPath = namePNGPath, portraitPNGPath = portraitPNGPath}
 end
 function getBossPNGPathsCustom(self, customStage)

package/dist/src/classes/features/other/customStages/versusScreen.lua

@@ -25,10 +25,10 @@ local getScreenCenterPos = ____ui.getScreenCenterPos
 local ____utils = require("src.functions.utils")
 local eRange = ____utils.eRange
 local ____versusScreen = require("src.functions.versusScreen")
-local getBossNameFilePath = ____versusScreen.getBossNameFilePath
-local getBossPortraitFilePath = ____versusScreen.getBossPortraitFilePath
-local getCharacterNameFilePath = ____versusScreen.getCharacterNameFilePath
-local getCharacterPortraitFilePath = ____versusScreen.getCharacterPortraitFilePath
+local getBossNamePNGFilePath = ____versusScreen.getBossNamePNGFilePath
+local getBossPortraitPNGFilePath = ____versusScreen.getBossPortraitPNGFilePath
+local getCharacterNamePNGFilePath = ____versusScreen.getCharacterNamePNGFilePath
+local getCharacterPortraitPNGFilePath = ____versusScreen.getCharacterPortraitPNGFilePath
 local ____versusScreenBackgroundColors = require("src.objects.versusScreenBackgroundColors")
 local VERSUS_SCREEN_BACKGROUND_COLORS = ____versusScreenBackgroundColors.VERSUS_SCREEN_BACKGROUND_COLORS
 local ____versusScreenDirtSpotColors = require("src.objects.versusScreenDirtSpotColors")
@@ -55,8 +55,8 @@ function getPlayerPNGPaths(self)
     if character == PlayerType.POSSESSOR then
         error("Failed to get the player PNG paths since they are a possessor.")
     end
-    local namePNGPath = getCharacterNameFilePath(nil, character)
-    local portraitPNGPath = getCharacterPortraitFilePath(nil, character)
+    local namePNGPath = getCharacterNamePNGFilePath(nil, character)
+    local portraitPNGPath = getCharacterPortraitPNGFilePath(nil, character)
     return {namePNGPath = namePNGPath, portraitPNGPath = portraitPNGPath}
 end
 function getBossPNGPaths(self, customStage)
@@ -68,13 +68,13 @@ function getBossPNGPaths(self, customStage)
     local firstBoss = bosses[1]
     local bossID = firstBoss == nil and 0 or firstBoss:GetBossID()
     if bossID == 0 then
-        local questionMarkPath = getBossNameFilePath(nil, BossID.BLUE_BABY)
+        local questionMarkPath = getBossNamePNGFilePath(nil, BossID.BLUE_BABY)
         local namePNGPath = questionMarkPath
         local portraitPNGPath = questionMarkPath
         return {namePNGPath = namePNGPath, portraitPNGPath = portraitPNGPath}
     end
-    local namePNGPath = getBossNameFilePath(nil, bossID)
-    local portraitPNGPath = getBossPortraitFilePath(nil, bossID)
+    local namePNGPath = getBossNamePNGFilePath(nil, bossID)
+    local portraitPNGPath = getBossPortraitPNGFilePath(nil, bossID)
     return {namePNGPath = namePNGPath, portraitPNGPath = portraitPNGPath}
 end
 function getBossPNGPathsCustom(self, customStage)

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

@@ -47,6 +47,13 @@ export declare function getCharacterDeathAnimationName(character: PlayerType): s
 export declare function getCharacterMaxHeartContainers(character: PlayerType): int;
 /** Helper function to get the name of a character. Returns "Unknown" for modded characters. */
 export declare function getCharacterName(character: PlayerType): string;
+/**
+ * Helper function to get the path to the sprite for a particular character.
+ *
+ * For example, the file path for `PlayerType.ISAAC` is
+ * "characters/costumes/character_001_isaac.png".
+ */
+export declare function getCharacterSpritePNGFilePath(character: PlayerType): string;
 /**
  * Helper function to get the collectibles that are granted to a particular character at the
  * beginning of a run.

package/dist/src/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;AAkB1D;;;;;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,8EAA8E;AAC9E,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,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;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,8EAA8E;AAC9E,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"}

package/dist/src/functions/characters.lua

@@ -12,6 +12,8 @@ local ____characterDamageMultipliers = require("src.objects.characterDamageMulti
 local CHARACTER_DAMAGE_MULTIPLIERS = ____characterDamageMultipliers.CHARACTER_DAMAGE_MULTIPLIERS
 local ____characterNames = require("src.objects.characterNames")
 local CHARACTER_NAMES = ____characterNames.CHARACTER_NAMES
+local ____characterSpritePNGFileNames = require("src.objects.characterSpritePNGFileNames")
+local CHARACTER_SPRITE_PNG_FILE_NAMES = ____characterSpritePNGFileNames.CHARACTER_SPRITE_PNG_FILE_NAMES
 local ____characterStartingCollectibleTypes = require("src.objects.characterStartingCollectibleTypes")
 local CHARACTER_STARTING_COLLECTIBLE_TYPES = ____characterStartingCollectibleTypes.CHARACTER_STARTING_COLLECTIBLE_TYPES
 local ____characterStartingTrinketTypes = require("src.objects.characterStartingTrinketTypes")
@@ -38,6 +40,7 @@ function ____exports.isVanillaCharacter(self, character)
 end
 local FLYING_CHARACTERS_SET = __TS__New(ReadonlySet, FLYING_CHARACTERS)
 local MAIN_CHARACTERS_SET = __TS__New(ReadonlySet, MAIN_CHARACTERS)
+local PNG_PATH_PREFIX = "characters/costumes"
 --- 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
@@ -116,6 +119,14 @@ function ____exports.getCharacterName(self, character)
     end
     return CHARACTER_NAMES[character]
 end
+--- Helper function to get the path to the sprite for a particular character.
+-- 
+-- For example, the file path for `PlayerType.ISAAC` is
+-- "characters/costumes/character_001_isaac.png".
+function ____exports.getCharacterSpritePNGFilePath(self, character)
+    local fileName = CHARACTER_SPRITE_PNG_FILE_NAMES[character]
+    return (PNG_PATH_PREFIX .. "/") .. fileName
+end
 --- Helper function to get the collectibles that are granted to a particular character at the
 -- beginning of a run.
 -- 

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

@@ -1,26 +1,30 @@
 import type { BossID, PlayerType } from "isaac-typescript-definitions";
 /**
  * Helper function to get the path to the name file that corresponds to the graphic shown on the
- * versus screen for the particular boss. For example, the file path for `BossID.MONSTRO` is
- * "gfx/ui/boss/bossname_20.0_monstro.png".
+ * versus screen for the particular boss.
+ *
+ * For example, the file path for `BossID.MONSTRO` is "gfx/ui/boss/bossname_20.0_monstro.png".
  */
-export declare function getBossNameFilePath(bossID: BossID): string;
+export declare function getBossNamePNGFilePath(bossID: BossID): string;
 /**
  * Helper function to get the path to the portrait file that corresponds to the graphic shown on the
- * versus screen for the particular boss. For example, the file path for `BossID.MONSTRO` is
- * "gfx/ui/boss/portrait_20.0_monstro.png".
+ * versus screen for the particular boss.
+ *
+ * For example, the file path for `BossID.MONSTRO` is "gfx/ui/boss/portrait_20.0_monstro.png".
  */
-export declare function getBossPortraitFilePath(bossID: BossID): string;
+export declare function getBossPortraitPNGFilePath(bossID: BossID): string;
 /**
  * Helper function to get the path to the name file that corresponds to the graphic shown on the
- * versus screen for the particular character. For example, the file path for `PlayerType.ISAAC` is
- * "gfx/ui/boss/playername_01_isaac.png".
+ * versus screen for the particular character.
+ *
+ * For example, the file path for `PlayerType.ISAAC` is "gfx/ui/boss/playername_01_isaac.png".
  */
-export declare function getCharacterNameFilePath(character: PlayerType): string;
+export declare function getCharacterNamePNGFilePath(character: PlayerType): string;
 /**
  * Helper function to get the path to the portrait file that corresponds to the graphic shown on the
- * versus screen for the particular character. For example, the file path for `PlayerType.ISAAC` is
- * "gfx/ui/boss/playerportrait_isaac.png".
+ * versus screen for the particular character.
+ *
+ * For example, the file path for `PlayerType.ISAAC` is "gfx/ui/boss/playerportrait_isaac.png".
  */
-export declare function getCharacterPortraitFilePath(character: PlayerType): string;
+export declare function getCharacterPortraitPNGFilePath(character: PlayerType): string;
 //# sourceMappingURL=versusScreen.d.ts.map

package/dist/src/functions/versusScreen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"versusScreen.d.ts","sourceRoot":"","sources":["../../../src/functions/versusScreen.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAevE;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG1D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAGtE;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAG1E"}
+{"version":3,"file":"versusScreen.d.ts","sourceRoot":"","sources":["../../../src/functions/versusScreen.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAevE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG7D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAGjE;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAGzE;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAG7E"}

package/dist/src/functions/versusScreen.lua

@@ -13,30 +13,34 @@ local PNG_PATH_PREFIX = "gfx/ui/boss"
 -- from the animation where the player travels to a new stage.
 local PLAYER_PORTRAIT_PNG_PATH_PREFIX = "gfx/ui/stage"
 --- Helper function to get the path to the name file that corresponds to the graphic shown on the
--- versus screen for the particular boss. For example, the file path for `BossID.MONSTRO` is
--- "gfx/ui/boss/bossname_20.0_monstro.png".
-function ____exports.getBossNameFilePath(self, bossID)
+-- versus screen for the particular boss.
+-- 
+-- For example, the file path for `BossID.MONSTRO` is "gfx/ui/boss/bossname_20.0_monstro.png".
+function ____exports.getBossNamePNGFilePath(self, bossID)
     local fileName = BOSS_NAME_PNG_FILE_NAMES[bossID]
     return (PNG_PATH_PREFIX .. "/") .. fileName
 end
 --- Helper function to get the path to the portrait file that corresponds to the graphic shown on the
--- versus screen for the particular boss. For example, the file path for `BossID.MONSTRO` is
--- "gfx/ui/boss/portrait_20.0_monstro.png".
-function ____exports.getBossPortraitFilePath(self, bossID)
+-- versus screen for the particular boss.
+-- 
+-- For example, the file path for `BossID.MONSTRO` is "gfx/ui/boss/portrait_20.0_monstro.png".
+function ____exports.getBossPortraitPNGFilePath(self, bossID)
     local fileName = BOSS_PORTRAIT_PNG_FILE_NAMES[bossID]
     return (PNG_PATH_PREFIX .. "/") .. fileName
 end
 --- Helper function to get the path to the name file that corresponds to the graphic shown on the
--- versus screen for the particular character. For example, the file path for `PlayerType.ISAAC` is
--- "gfx/ui/boss/playername_01_isaac.png".
-function ____exports.getCharacterNameFilePath(self, character)
+-- versus screen for the particular character.
+-- 
+-- For example, the file path for `PlayerType.ISAAC` is "gfx/ui/boss/playername_01_isaac.png".
+function ____exports.getCharacterNamePNGFilePath(self, character)
     local fileName = PLAYER_NAME_PNG_FILE_NAMES[character]
     return (PNG_PATH_PREFIX .. "/") .. tostring(fileName)
 end
 --- Helper function to get the path to the portrait file that corresponds to the graphic shown on the
--- versus screen for the particular character. For example, the file path for `PlayerType.ISAAC` is
--- "gfx/ui/boss/playerportrait_isaac.png".
-function ____exports.getCharacterPortraitFilePath(self, character)
+-- versus screen for the particular character.
+-- 
+-- For example, the file path for `PlayerType.ISAAC` is "gfx/ui/boss/playerportrait_isaac.png".
+function ____exports.getCharacterPortraitPNGFilePath(self, character)
     local fileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[character]
     return (PLAYER_PORTRAIT_PNG_PATH_PREFIX .. "/") .. tostring(fileName)
 end

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

@@ -0,0 +1,45 @@
+export declare const CHARACTER_SPRITE_PNG_FILE_NAMES: {
+    readonly [-1]: "character_001_isaac.png";
+    readonly 0: "character_001_isaac.png";
+    readonly 1: "character_002_magdalene.png";
+    readonly 2: "character_003_cain.png";
+    readonly 3: "character_004_judas.png";
+    readonly 4: "character_006_bluebaby.png";
+    readonly 5: "character_005_eve.png";
+    readonly 6: "character_007_samson.png";
+    readonly 7: "character_008_azazel.png";
+    readonly 8: "character_009_lazarus.png";
+    readonly 9: "character_009_eden.png";
+    readonly 10: "character_012_thelost.png";
+    readonly 11: "character_010_lazarus2.png";
+    readonly 12: "character_013_blackjudas.png";
+    readonly 13: "character_014_lilith.png";
+    readonly 14: "character_015_keeper.png";
+    readonly 15: "character_016_apollyon.png";
+    readonly 16: "character_017_theforgotten.png";
+    readonly 17: "character_018_thesoul.png";
+    readonly 18: "character_001x_bethany.png";
+    readonly 19: "character_002x_jacob.png";
+    readonly 20: "character_003x_esau.png";
+    readonly 21: "character_001b_isaac.png";
+    readonly 22: "character_002b_magdalene.png";
+    readonly 23: "character_003b_cain.png";
+    readonly 24: "character_004b_judas.png";
+    readonly 25: "character_005b_bluebaby.png";
+    readonly 26: "character_006b_eve.png";
+    readonly 27: "character_007b_samson.png";
+    readonly 28: "character_008b_azazel.png";
+    readonly 29: "character_009b_lazarus.png";
+    readonly 30: "character_009_eden.png";
+    readonly 31: "character_012b_thelost.png";
+    readonly 32: "character_014b_lilith.png";
+    readonly 33: "character_015b_keeper.png";
+    readonly 34: "character_016b_apollyon.png";
+    readonly 35: "character_016b_theforgotten.png";
+    readonly 36: "character_018b_bethany.png";
+    readonly 37: "character_019b_jacob.png";
+    readonly 38: "character_009b_lazarus2.png";
+    readonly 39: "character_019b_jacob2.png";
+    readonly 40: "character_017b_thesoul.png";
+};
+//# sourceMappingURL=characterSpritePNGFileNames.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"characterSpritePNGFileNames.d.ts","sourceRoot":"","sources":["../../../src/objects/characterSpritePNGFileNames.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4CG,CAAC"}

package/dist/src/objects/characterSpritePNGFileNames.lua

@@ -0,0 +1,48 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+____exports.CHARACTER_SPRITE_PNG_FILE_NAMES = {
+    [PlayerType.POSSESSOR] = "character_001_isaac.png",
+    [PlayerType.ISAAC] = "character_001_isaac.png",
+    [PlayerType.MAGDALENE] = "character_002_magdalene.png",
+    [PlayerType.CAIN] = "character_003_cain.png",
+    [PlayerType.JUDAS] = "character_004_judas.png",
+    [PlayerType.BLUE_BABY] = "character_006_bluebaby.png",
+    [PlayerType.EVE] = "character_005_eve.png",
+    [PlayerType.SAMSON] = "character_007_samson.png",
+    [PlayerType.AZAZEL] = "character_008_azazel.png",
+    [PlayerType.LAZARUS] = "character_009_lazarus.png",
+    [PlayerType.EDEN] = "character_009_eden.png",
+    [PlayerType.LOST] = "character_012_thelost.png",
+    [PlayerType.LAZARUS_2] = "character_010_lazarus2.png",
+    [PlayerType.DARK_JUDAS] = "character_013_blackjudas.png",
+    [PlayerType.LILITH] = "character_014_lilith.png",
+    [PlayerType.KEEPER] = "character_015_keeper.png",
+    [PlayerType.APOLLYON] = "character_016_apollyon.png",
+    [PlayerType.FORGOTTEN] = "character_017_theforgotten.png",
+    [PlayerType.SOUL] = "character_018_thesoul.png",
+    [PlayerType.BETHANY] = "character_001x_bethany.png",
+    [PlayerType.JACOB] = "character_002x_jacob.png",
+    [PlayerType.ESAU] = "character_003x_esau.png",
+    [PlayerType.ISAAC_B] = "character_001b_isaac.png",
+    [PlayerType.MAGDALENE_B] = "character_002b_magdalene.png",
+    [PlayerType.CAIN_B] = "character_003b_cain.png",
+    [PlayerType.JUDAS_B] = "character_004b_judas.png",
+    [PlayerType.BLUE_BABY_B] = "character_005b_bluebaby.png",
+    [PlayerType.EVE_B] = "character_006b_eve.png",
+    [PlayerType.SAMSON_B] = "character_007b_samson.png",
+    [PlayerType.AZAZEL_B] = "character_008b_azazel.png",
+    [PlayerType.LAZARUS_B] = "character_009b_lazarus.png",
+    [PlayerType.EDEN_B] = "character_009_eden.png",
+    [PlayerType.LOST_B] = "character_012b_thelost.png",
+    [PlayerType.LILITH_B] = "character_014b_lilith.png",
+    [PlayerType.KEEPER_B] = "character_015b_keeper.png",
+    [PlayerType.APOLLYON_B] = "character_016b_apollyon.png",
+    [PlayerType.FORGOTTEN_B] = "character_016b_theforgotten.png",
+    [PlayerType.BETHANY_B] = "character_018b_bethany.png",
+    [PlayerType.JACOB_B] = "character_019b_jacob.png",
+    [PlayerType.LAZARUS_2_B] = "character_009b_lazarus2.png",
+    [PlayerType.JACOB_2_B] = "character_019b_jacob2.png",
+    [PlayerType.SOUL_B] = "character_017b_thesoul.png"
+}
+return ____exports

package/package.json

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

package/src/classes/features/other/customStages/versusScreen.ts

@@ -15,10 +15,10 @@ import { removeCharactersBefore } from "../../../../functions/string";
 import { getScreenCenterPos } from "../../../../functions/ui";
 import { eRange } from "../../../../functions/utils";
 import {
-  getBossNameFilePath,
-  getBossPortraitFilePath,
-  getCharacterNameFilePath,
-  getCharacterPortraitFilePath,
+  getBossNamePNGFilePath,
+  getBossPortraitPNGFilePath,
+  getCharacterNamePNGFilePath,
+  getCharacterPortraitPNGFilePath,
 } from "../../../../functions/versusScreen";
 import type { CustomStage } from "../../../../interfaces/private/CustomStage";
 import { VERSUS_SCREEN_BACKGROUND_COLORS } from "../../../../objects/versusScreenBackgroundColors";
@@ -232,8 +232,8 @@ function getPlayerPNGPaths(): {
     error("Failed to get the player PNG paths since they are a possessor.");
   }
 
-  const namePNGPath = getCharacterNameFilePath(character);
-  const portraitPNGPath = getCharacterPortraitFilePath(character);
+  const namePNGPath = getCharacterNamePNGFilePath(character);
+  const portraitPNGPath = getCharacterPortraitPNGFilePath(character);
 
   return { namePNGPath, portraitPNGPath };
 }
@@ -254,7 +254,7 @@ function getBossPNGPaths(customStage: CustomStage): {
   const firstBoss = bosses[0];
   const bossID = firstBoss === undefined ? 0 : firstBoss.GetBossID();
   if (bossID === 0) {
-    const questionMarkPath = getBossNameFilePath(BossID.BLUE_BABY);
+    const questionMarkPath = getBossNamePNGFilePath(BossID.BLUE_BABY);
     const namePNGPath = questionMarkPath;
     const portraitPNGPath = questionMarkPath;
     return { namePNGPath, portraitPNGPath };
@@ -262,8 +262,8 @@ function getBossPNGPaths(customStage: CustomStage): {
 
   // If this is a vanilla boss, it will have a boss ID, and we can use the corresponding vanilla
   // files.
-  const namePNGPath = getBossNameFilePath(bossID);
-  const portraitPNGPath = getBossPortraitFilePath(bossID);
+  const namePNGPath = getBossNamePNGFilePath(bossID);
+  const portraitPNGPath = getBossPortraitPNGFilePath(bossID);
 
   return { namePNGPath, portraitPNGPath };
 }

package/src/functions/characters.ts

@@ -7,6 +7,7 @@ import { FLYING_CHARACTERS, MAIN_CHARACTERS } from "../core/constants";
 import { LAST_VANILLA_CHARACTER } from "../core/constantsFirstLast";
 import { CHARACTER_DAMAGE_MULTIPLIERS } from "../objects/characterDamageMultipliers";
 import { CHARACTER_NAMES } from "../objects/characterNames";
+import { CHARACTER_SPRITE_PNG_FILE_NAMES } from "../objects/characterSpritePNGFileNames";
 import { CHARACTER_STARTING_COLLECTIBLE_TYPES } from "../objects/characterStartingCollectibleTypes";
 import { CHARACTER_STARTING_TRINKET_TYPE } from "../objects/characterStartingTrinketTypes";
 import { CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET } from "../sets/charactersThatStartWithAnActiveItemSet";
@@ -20,6 +21,8 @@ import { ReadonlySet } from "../types/ReadonlySet";
 const FLYING_CHARACTERS_SET = new ReadonlySet<PlayerType>(FLYING_CHARACTERS);
 const MAIN_CHARACTERS_SET = new ReadonlySet<PlayerType>(MAIN_CHARACTERS);
 
+const PNG_PATH_PREFIX = "characters/costumes";
+
 /**
  * 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
@@ -135,6 +138,17 @@ export function getCharacterName(character: PlayerType): string {
   return CHARACTER_NAMES[character];
 }
 
+/**
+ * Helper function to get the path to the sprite for a particular character.
+ *
+ * For example, the file path for `PlayerType.ISAAC` is
+ * "characters/costumes/character_001_isaac.png".
+ */
+export function getCharacterSpritePNGFilePath(character: PlayerType): string {
+  const fileName = CHARACTER_SPRITE_PNG_FILE_NAMES[character];
+  return `${PNG_PATH_PREFIX}/${fileName}`;
+}
+
 /**
  * Helper function to get the collectibles that are granted to a particular character at the
  * beginning of a run.

package/src/functions/versusScreen.ts

@@ -15,40 +15,44 @@ const PLAYER_PORTRAIT_PNG_PATH_PREFIX = "gfx/ui/stage";
 
 /**
  * Helper function to get the path to the name file that corresponds to the graphic shown on the
- * versus screen for the particular boss. For example, the file path for `BossID.MONSTRO` is
- * "gfx/ui/boss/bossname_20.0_monstro.png".
+ * versus screen for the particular boss.
+ *
+ * For example, the file path for `BossID.MONSTRO` is "gfx/ui/boss/bossname_20.0_monstro.png".
  */
-export function getBossNameFilePath(bossID: BossID): string {
+export function getBossNamePNGFilePath(bossID: BossID): string {
   const fileName = BOSS_NAME_PNG_FILE_NAMES[bossID];
   return `${PNG_PATH_PREFIX}/${fileName}`;
 }
 
 /**
  * Helper function to get the path to the portrait file that corresponds to the graphic shown on the
- * versus screen for the particular boss. For example, the file path for `BossID.MONSTRO` is
- * "gfx/ui/boss/portrait_20.0_monstro.png".
+ * versus screen for the particular boss.
+ *
+ * For example, the file path for `BossID.MONSTRO` is "gfx/ui/boss/portrait_20.0_monstro.png".
  */
-export function getBossPortraitFilePath(bossID: BossID): string {
+export function getBossPortraitPNGFilePath(bossID: BossID): string {
   const fileName = BOSS_PORTRAIT_PNG_FILE_NAMES[bossID];
   return `${PNG_PATH_PREFIX}/${fileName}`;
 }
 
 /**
  * Helper function to get the path to the name file that corresponds to the graphic shown on the
- * versus screen for the particular character. For example, the file path for `PlayerType.ISAAC` is
- * "gfx/ui/boss/playername_01_isaac.png".
+ * versus screen for the particular character.
+ *
+ * For example, the file path for `PlayerType.ISAAC` is "gfx/ui/boss/playername_01_isaac.png".
  */
-export function getCharacterNameFilePath(character: PlayerType): string {
+export function getCharacterNamePNGFilePath(character: PlayerType): string {
   const fileName = PLAYER_NAME_PNG_FILE_NAMES[character];
   return `${PNG_PATH_PREFIX}/${fileName}`;
 }
 
 /**
  * Helper function to get the path to the portrait file that corresponds to the graphic shown on the
- * versus screen for the particular character. For example, the file path for `PlayerType.ISAAC` is
- * "gfx/ui/boss/playerportrait_isaac.png".
+ * versus screen for the particular character.
+ *
+ * For example, the file path for `PlayerType.ISAAC` is "gfx/ui/boss/playerportrait_isaac.png".
  */
-export function getCharacterPortraitFilePath(character: PlayerType): string {
+export function getCharacterPortraitPNGFilePath(character: PlayerType): string {
   const fileName = PLAYER_PORTRAIT_PNG_FILE_NAMES[character];
   return `${PLAYER_PORTRAIT_PNG_PATH_PREFIX}/${fileName}`;
 }

package/src/objects/characterSpritePNGFileNames.ts

@@ -0,0 +1,49 @@
+// cspell:disable
+
+import { PlayerType } from "isaac-typescript-definitions";
+
+export const CHARACTER_SPRITE_PNG_FILE_NAMES = {
+  // Possessor uses the same sprite as Isaac.
+  [PlayerType.POSSESSOR]: "character_001_isaac.png", // 0
+  [PlayerType.ISAAC]: "character_001_isaac.png", // 0
+  [PlayerType.MAGDALENE]: "character_002_magdalene.png", // 1
+  [PlayerType.CAIN]: "character_003_cain.png", // 2
+  [PlayerType.JUDAS]: "character_004_judas.png", // 3
+  [PlayerType.BLUE_BABY]: "character_006_bluebaby.png", // 4
+  [PlayerType.EVE]: "character_005_eve.png", // 5
+  [PlayerType.SAMSON]: "character_007_samson.png", // 6
+  [PlayerType.AZAZEL]: "character_008_azazel.png", // 7
+  [PlayerType.LAZARUS]: "character_009_lazarus.png", // 8
+  [PlayerType.EDEN]: "character_009_eden.png", // 9
+  [PlayerType.LOST]: "character_012_thelost.png", // 10
+  [PlayerType.LAZARUS_2]: "character_010_lazarus2.png", // 11
+  [PlayerType.DARK_JUDAS]: "character_013_blackjudas.png", // 12
+  [PlayerType.LILITH]: "character_014_lilith.png", // 13
+  [PlayerType.KEEPER]: "character_015_keeper.png", // 14
+  [PlayerType.APOLLYON]: "character_016_apollyon.png", // 15
+  [PlayerType.FORGOTTEN]: "character_017_theforgotten.png", // 16
+  [PlayerType.SOUL]: "character_018_thesoul.png", // 17
+  [PlayerType.BETHANY]: "character_001x_bethany.png", // 18
+  [PlayerType.JACOB]: "character_002x_jacob.png", // 19
+  [PlayerType.ESAU]: "character_003x_esau.png", // 20
+  [PlayerType.ISAAC_B]: "character_001b_isaac.png", // 21
+  [PlayerType.MAGDALENE_B]: "character_002b_magdalene.png", // 22
+  [PlayerType.CAIN_B]: "character_003b_cain.png", // 23
+  [PlayerType.JUDAS_B]: "character_004b_judas.png", // 24
+  [PlayerType.BLUE_BABY_B]: "character_005b_bluebaby.png", // 25
+  [PlayerType.EVE_B]: "character_006b_eve.png", // 26
+  [PlayerType.SAMSON_B]: "character_007b_samson.png", // 27
+  [PlayerType.AZAZEL_B]: "character_008b_azazel.png", // 28
+  [PlayerType.LAZARUS_B]: "character_009b_lazarus.png", // 29
+  [PlayerType.EDEN_B]: "character_009_eden.png", // 30
+  [PlayerType.LOST_B]: "character_012b_thelost.png", // 31
+  [PlayerType.LILITH_B]: "character_014b_lilith.png", // 32
+  [PlayerType.KEEPER_B]: "character_015b_keeper.png", // 33
+  [PlayerType.APOLLYON_B]: "character_016b_apollyon.png", // 34
+  [PlayerType.FORGOTTEN_B]: "character_016b_theforgotten.png", // 35
+  [PlayerType.BETHANY_B]: "character_018b_bethany.png", // 36
+  [PlayerType.JACOB_B]: "character_019b_jacob.png", // 37
+  [PlayerType.LAZARUS_2_B]: "character_009b_lazarus2.png", // 38
+  [PlayerType.JACOB_2_B]: "character_019b_jacob2.png", // 39
+  [PlayerType.SOUL_B]: "character_017b_thesoul.png", // 40
+} as const satisfies Record<PlayerType, string>;