isaacscript-common 39.4.6 → 39.5.0

package/dist/index.rollup.d.ts

@@ -8840,6 +8840,12 @@ export declare function isLRoomShape(roomShape: RoomShape): boolean;
  */
 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;
+
 /**
  * Helper function to check if the provided door is the one that leads to the Mega Satan Boss Room.
  * (In vanilla, the door will only appear in the starting room of The Chest / Dark Room.)
@@ -13940,6 +13946,9 @@ export declare function onRepentanceStage(): boolean;
  * Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
  * pressing tab on the character selection screen). When the player resets the game on a set seed,
  * the game will not switch to a different seed.
+ *
+ * Under the hood, this checks if the current challenge is `Challenge.NULL` and the
+ * `Seeds.IsCustomRun` method.
  */
 export declare function onSetSeed(): boolean;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 39.4.6
+isaacscript-common 39.5.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -19297,7 +19297,7 @@ end
 function ____exports.isVanillaCharacter(self, character)
     return character <= LAST_VANILLA_CHARACTER
 end
-local FLYING_CHARACTERS = __TS__New(ReadonlySet, {
+local FLYING_CHARACTERS_SET = __TS__New(ReadonlySet, {
     PlayerType.AZAZEL,
     PlayerType.LOST,
     PlayerType.SOUL,
@@ -19305,6 +19305,42 @@ local FLYING_CHARACTERS = __TS__New(ReadonlySet, {
     PlayerType.JACOB_2_B,
     PlayerType.SOUL_B
 })
+local MAIN_CHARACTERS_SET = __TS__New(ReadonlySet, {
+    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
+})
 function ____exports.characterCanHaveRedHearts(self, character)
     return not CHARACTERS_WITH_NO_RED_HEARTS_SET:has(character)
 end
@@ -19364,7 +19400,10 @@ function ____exports.getCharacterStartingCollectibles(self, character)
 end
 function ____exports.isFlyingCharacter(self, player)
     local character = player:GetPlayerType()
-    return FLYING_CHARACTERS:has(character)
+    return FLYING_CHARACTERS_SET:has(character)
+end
+function ____exports.isMainCharacter(self, character)
+    return MAIN_CHARACTERS_SET:has(character)
 end
 return ____exports
  end,

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

@@ -55,6 +55,11 @@ export declare function getCharacterName(character: PlayerType): string;
  */
 export declare function getCharacterStartingCollectibles(character: PlayerType): readonly CollectibleType[];
 export declare function isFlyingCharacter(player: EntityPlayer): 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 isModdedCharacter(character: PlayerType): boolean;
 export declare function isVanillaCharacter(character: PlayerType): boolean;
 //# sourceMappingURL=characters.d.ts.map

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,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAsB1D;;;;;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,gCAAgC,CAC9C,SAAS,EAAE,UAAU,GACpB,SAAS,eAAe,EAAE,CAE5B;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG/D;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,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AA2D1D;;;;;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,gCAAgC,CAC9C,SAAS,EAAE,UAAU,GACpB,SAAS,eAAe,EAAE,CAE5B;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG/D;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

@@ -31,7 +31,7 @@ end
 function ____exports.isVanillaCharacter(self, character)
     return character <= LAST_VANILLA_CHARACTER
 end
-local FLYING_CHARACTERS = __TS__New(ReadonlySet, {
+local FLYING_CHARACTERS_SET = __TS__New(ReadonlySet, {
     PlayerType.AZAZEL,
     PlayerType.LOST,
     PlayerType.SOUL,
@@ -39,6 +39,42 @@ local FLYING_CHARACTERS = __TS__New(ReadonlySet, {
     PlayerType.JACOB_2_B,
     PlayerType.SOUL_B
 })
+local MAIN_CHARACTERS_SET = __TS__New(ReadonlySet, {
+    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
+})
 --- 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
@@ -126,6 +162,11 @@ function ____exports.getCharacterStartingCollectibles(self, character)
 end
 function ____exports.isFlyingCharacter(self, player)
     local character = player:GetPlayerType()
-    return FLYING_CHARACTERS:has(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/src/functions/run.d.ts

@@ -13,6 +13,9 @@ export declare function isGreedMode(): boolean;
  * Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
  * pressing tab on the character selection screen). When the player resets the game on a set seed,
  * the game will not switch to a different seed.
+ *
+ * Under the hood, this checks if the current challenge is `Challenge.NULL` and the
+ * `Seeds.IsCustomRun` method.
  */
 export declare function onSetSeed(): boolean;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAa/D;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,OAAO,CAUlD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAKrC;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAkBpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAUlC"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/functions/run.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAa/D;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,OAAO,CAUlD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAKrC;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAMnC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI,CAkBpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAUlC"}

package/dist/src/functions/run.lua

@@ -31,6 +31,9 @@ end
 --- Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
 -- pressing tab on the character selection screen). When the player resets the game on a set seed,
 -- the game will not switch to a different seed.
+-- 
+-- Under the hood, this checks if the current challenge is `Challenge.NULL` and the
+-- `Seeds.IsCustomRun` method.
 function ____exports.onSetSeed(self)
     local seeds = game:GetSeeds()
     local customRun = seeds:IsCustomRun()

package/package.json

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

package/src/functions/characters.ts

@@ -12,7 +12,7 @@ import { CHARACTERS_WITH_NO_SOUL_HEARTS_SET } from "../sets/charactersWithNoSoul
 import { LOST_STYLE_CHARACTERS_SET } from "../sets/lostStyleCharactersSet";
 import { ReadonlySet } from "../types/ReadonlySet";
 
-const FLYING_CHARACTERS = new ReadonlySet<PlayerType>([
+const FLYING_CHARACTERS_SET = new ReadonlySet<PlayerType>([
   PlayerType.AZAZEL, // 7
   PlayerType.LOST, // 10
   PlayerType.SOUL, // 17
@@ -21,6 +21,43 @@ const FLYING_CHARACTERS = new ReadonlySet<PlayerType>([
   PlayerType.SOUL_B, // 40
 ]);
 
+const MAIN_CHARACTERS_SET = new ReadonlySet<PlayerType>([
+  PlayerType.ISAAC, // 0
+  PlayerType.MAGDALENE, // 1
+  PlayerType.CAIN, // 2
+  PlayerType.JUDAS, // 3
+  PlayerType.BLUE_BABY, // 4
+  PlayerType.EVE, // 5
+  PlayerType.SAMSON, // 6
+  PlayerType.AZAZEL, // 7
+  PlayerType.LAZARUS, // 8
+  PlayerType.EDEN, // 9
+  PlayerType.LOST, // 10
+  PlayerType.LILITH, // 13
+  PlayerType.KEEPER, // 14
+  PlayerType.APOLLYON, // 15
+  PlayerType.FORGOTTEN, // 16
+  PlayerType.BETHANY, // 18
+  PlayerType.JACOB, // 19
+  PlayerType.ISAAC_B, // 21
+  PlayerType.MAGDALENE_B, // 22
+  PlayerType.CAIN_B, // 23
+  PlayerType.JUDAS_B, // 24
+  PlayerType.BLUE_BABY_B, // 25
+  PlayerType.EVE_B, // 26
+  PlayerType.SAMSON_B, // 27
+  PlayerType.AZAZEL_B, // 28
+  PlayerType.LAZARUS_B, // 29
+  PlayerType.EDEN_B, // 30
+  PlayerType.LOST_B, // 31
+  PlayerType.LILITH_B, // 32
+  PlayerType.KEEPER_B, // 33
+  PlayerType.APOLLYON_B, // 34
+  PlayerType.FORGOTTEN_B, // 35
+  PlayerType.BETHANY_B, // 36
+  PlayerType.JACOB_B, // 37
+]);
+
 /**
  * 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
@@ -150,7 +187,15 @@ export function getCharacterStartingCollectibles(
 
 export function isFlyingCharacter(player: EntityPlayer): boolean {
   const character = player.GetPlayerType();
-  return FLYING_CHARACTERS.has(character);
+  return FLYING_CHARACTERS_SET.has(character);
+}
+
+/**
+ * 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 {
+  return MAIN_CHARACTERS_SET.has(character);
 }
 
 export function isModdedCharacter(character: PlayerType): boolean {

package/src/functions/run.ts

@@ -42,6 +42,9 @@ export function isGreedMode(): boolean {
  * Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
  * pressing tab on the character selection screen). When the player resets the game on a set seed,
  * the game will not switch to a different seed.
+ *
+ * Under the hood, this checks if the current challenge is `Challenge.NULL` and the
+ * `Seeds.IsCustomRun` method.
  */
 export function onSetSeed(): boolean {
   const seeds = game.GetSeeds();