isaacscript-common 77.1.0 → 77.2.1

package/dist/sets/bossSets.d.ts

@@ -1,8 +1,6 @@
-import { BossID, EntityType, LevelStage } from "isaac-typescript-definitions";
+import { BossID, LevelStage } from "isaac-typescript-definitions";
 export declare const STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP: ReadonlyMap<LevelStage, ReadonlyMap<int, ReadonlySet<BossID>>>;
 export declare const STAGE_TO_COMBINED_BOSS_SET_MAP: ReadonlyMap<LevelStage, ReadonlySet<BossID>>;
 export declare const ALL_BOSSES_SET: ReadonlySet<BossID>;
-export declare const STORY_BOSS_IDS_SET: ReadonlySet<BossID>;
-export declare const STORY_BOSS_ENTITY_TYPES_SET: ReadonlySet<EntityType>;
 export declare const ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET: ReadonlySet<BossID>;
 //# sourceMappingURL=bossSets.d.ts.map

package/dist/sets/bossSets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bossSets.d.ts","sourceRoot":"","sources":["../../src/sets/bossSets.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,UAAU,EACV,UAAU,EAEX,MAAM,8BAA8B,CAAC;AA6etC,eAAO,MAAM,mCAAmC,gEAiB9C,CAAC;AAEH,eAAO,MAAM,8BAA8B,8CAiBzC,CAAC;AAEH,eAAO,MAAM,cAAc,qBAE1B,CAAC;AAEF,eAAO,MAAM,kBAAkB,qBAkB7B,CAAC;AAEH,eAAO,MAAM,2BAA2B,yBActC,CAAC;AAEH,eAAO,MAAM,qCAAqC,qBAEjD,CAAC"}
+{"version":3,"file":"bossSets.d.ts","sourceRoot":"","sources":["../../src/sets/bossSets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAa,MAAM,8BAA8B,CAAC;AA8e7E,eAAO,MAAM,mCAAmC,gEAiB9C,CAAC;AAEH,eAAO,MAAM,8BAA8B,8CAiBzC,CAAC;AAEH,eAAO,MAAM,cAAc,qBAE1B,CAAC;AAEF,eAAO,MAAM,qCAAqC,qBAEjD,CAAC"}

package/dist/sets/bossSets.lua

@@ -5,13 +5,14 @@ local __TS__Spread = ____lualib.__TS__Spread
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local BossID = ____isaac_2Dtypescript_2Ddefinitions.BossID
-local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
 local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
 local ____cachedEnumValues = require("arrays.cachedEnumValues")
 local BOSS_IDS = ____cachedEnumValues.BOSS_IDS
 local ____set = require("functions.set")
 local combineSets = ____set.combineSets
+local ____storyBosses = require("functions.storyBosses")
+local isStoryBossID = ____storyBosses.isStoryBossID
 local ____ReadonlyMap = require("types.ReadonlyMap")
 local ReadonlyMap = ____ReadonlyMap.ReadonlyMap
 local ____ReadonlySet = require("types.ReadonlySet")
@@ -369,45 +370,11 @@ ____exports.ALL_BOSSES_SET = __TS__New(
         function(____, bossID) return bossID ~= BossID.RAGLICH end
     )
 )
-____exports.STORY_BOSS_IDS_SET = __TS__New(ReadonlySet, {
-    BossID.MOM,
-    BossID.MOMS_HEART,
-    BossID.SATAN,
-    BossID.IT_LIVES,
-    BossID.ISAAC,
-    BossID.BLUE_BABY,
-    BossID.LAMB,
-    BossID.MEGA_SATAN,
-    BossID.ULTRA_GREED,
-    BossID.HUSH,
-    BossID.DELIRIUM,
-    BossID.ULTRA_GREEDIER,
-    BossID.MOTHER,
-    BossID.MAUSOLEUM_MOM,
-    BossID.MAUSOLEUM_MOMS_HEART,
-    BossID.DOGMA,
-    BossID.BEAST
-})
-____exports.STORY_BOSS_ENTITY_TYPES_SET = __TS__New(ReadonlySet, {
-    EntityType.MOM,
-    EntityType.MOMS_HEART,
-    EntityType.SATAN,
-    EntityType.ISAAC,
-    EntityType.LAMB,
-    EntityType.MEGA_SATAN,
-    EntityType.MEGA_SATAN_2,
-    EntityType.ULTRA_GREED,
-    EntityType.HUSH,
-    EntityType.DELIRIUM,
-    EntityType.MOTHER,
-    EntityType.DOGMA,
-    EntityType.BEAST
-})
 ____exports.ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET = __TS__New(
     ReadonlySet,
     __TS__ArrayFilter(
         {__TS__Spread(____exports.ALL_BOSSES_SET)},
-        function(____, bossID) return not ____exports.STORY_BOSS_IDS_SET:has(bossID) end
+        function(____, bossID) return not isStoryBossID(nil, bossID) end
     )
 )
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "77.1.0",
+  "version": "77.2.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -37,6 +37,6 @@
     "lint": "tsx --tsconfig ./scripts/tsconfig.json ./scripts/lint.mts"
   },
   "dependencies": {
-    "isaac-typescript-definitions": "^38.1.0"
+    "isaac-typescript-definitions": "^38.2.0"
   }
 }

package/src/functions/bosses.ts

@@ -15,8 +15,6 @@ import {
   ALL_BOSSES_SET,
   STAGE_TO_COMBINED_BOSS_SET_MAP,
   STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP,
-  STORY_BOSS_ENTITY_TYPES_SET,
-  STORY_BOSS_IDS_SET,
 } from "../sets/bossSets";
 import { REPENTANCE_ONLY_BOSS_IDS_SET } from "../sets/repentanceBossIDsSet";
 import { SIN_ENTITY_TYPES_SET } from "../sets/sinEntityTypesSet";
@@ -251,24 +249,6 @@ function getNumBossSegments(
   }
 }
 
-/**
- * Helper function to determine if the specified entity type is an end-game story boss, like Isaac,
- * Blue Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only
- * apply to non-story bosses, like Vanishing Twin.
- */
-export function isStoryBoss(entityType: EntityType): boolean {
-  return STORY_BOSS_ENTITY_TYPES_SET.has(entityType);
-}
-
-/**
- * Helper function to determine if the specified boss ID is an end-game story boss, like Isaac, Blue
- * Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only apply
- * to non-story bosses, like Vanishing Twin.
- */
-export function isStoryBossID(bossID: BossID): boolean {
-  return STORY_BOSS_IDS_SET.has(bossID);
-}
-
 /**
  * Helper function to spawn a boss.
  *

package/src/functions/storyBosses.ts

@@ -0,0 +1,69 @@
+import { BossID, EntityType } from "isaac-typescript-definitions";
+import { ReadonlySet } from "../types/ReadonlySet";
+
+const STORY_BOSS_IDS = [
+  BossID.MOM, // 6
+  BossID.MOMS_HEART, // 8
+  BossID.SATAN, // 24
+  BossID.IT_LIVES, // 25
+  BossID.ISAAC, // 39
+  BossID.BLUE_BABY, // 40
+  BossID.LAMB, // 54
+  BossID.MEGA_SATAN, // 55 (Mega Satan 2 is in the same room.)
+  BossID.ULTRA_GREED, // 62
+  BossID.HUSH, // 63
+  BossID.DELIRIUM, // 70
+  BossID.ULTRA_GREEDIER, // 71
+  BossID.MOTHER, // 88
+  BossID.MAUSOLEUM_MOM, // 89
+  BossID.MAUSOLEUM_MOMS_HEART, // 90
+  BossID.DOGMA, // 99
+  BossID.BEAST, // 100
+] as const;
+
+const STORY_BOSS_ENTITY_TYPES_SET = new ReadonlySet([
+  EntityType.MOM, // 45
+  EntityType.MOMS_HEART, // 78
+  EntityType.SATAN, // 84
+  // - It Lives is a variant of Mom's Heart.
+  EntityType.ISAAC, // 102
+  // - Blue Baby is a variant of Isaac.
+  EntityType.LAMB, // 273
+  EntityType.MEGA_SATAN, // 274
+  EntityType.MEGA_SATAN_2, // 275
+  EntityType.ULTRA_GREED, // 406
+  EntityType.HUSH, // 407
+  EntityType.DELIRIUM, // 412
+  // - Ultra Greedier is a variant of Ultra Greed.
+  EntityType.MOTHER, // 912
+  // - Mausoleum Mom is a sub-type of Mom.
+  // - Mausoleum Mom's Heart is a sub-type of Mom's Heart.
+  EntityType.DOGMA, // 950
+  EntityType.BEAST, // 951
+]);
+
+const STORY_BOSS_IDS_SET = new ReadonlySet<BossID>(STORY_BOSS_IDS);
+
+/**
+ * A helper type that is a union of every story boss. Useful for data structures that must contain
+ * one entry for each story boss.
+ */
+export type StoryBossID = (typeof STORY_BOSS_IDS)[number];
+
+/**
+ * Helper function to determine if the specified entity type is an end-game story boss, like Isaac,
+ * Blue Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only
+ * apply to non-story bosses, like Vanishing Twin.
+ */
+export function isStoryBoss(entityType: EntityType): boolean {
+  return STORY_BOSS_ENTITY_TYPES_SET.has(entityType);
+}
+
+/**
+ * Helper function to determine if the specified boss ID is an end-game story boss, like Isaac, Blue
+ * Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only apply
+ * to non-story bosses, like Vanishing Twin.
+ */
+export function isStoryBossID(bossID: BossID): bossID is StoryBossID {
+  return STORY_BOSS_IDS_SET.has(bossID);
+}

package/src/index.ts

@@ -122,6 +122,7 @@ export * from "./functions/spawnCollectible";
 export * from "./functions/sprites";
 export * from "./functions/stage";
 export * from "./functions/stats";
+export * from "./functions/storyBosses";
 export * from "./functions/string";
 export * from "./functions/table";
 export * from "./functions/tears";

package/src/sets/bossSets.ts

@@ -1,11 +1,7 @@
-import {
-  BossID,
-  EntityType,
-  LevelStage,
-  StageType,
-} from "isaac-typescript-definitions";
+import { BossID, LevelStage, StageType } from "isaac-typescript-definitions";
 import { BOSS_IDS } from "../arrays/cachedEnumValues";
 import { combineSets } from "../functions/set";
+import { isStoryBossID } from "../functions/storyBosses";
 import { ReadonlyMap } from "../types/ReadonlyMap";
 import { ReadonlySet } from "../types/ReadonlySet";
 
@@ -538,42 +534,6 @@ export const ALL_BOSSES_SET = new ReadonlySet<BossID>(
   BOSS_IDS.filter((bossID) => bossID !== BossID.RAGLICH),
 );
 
-export const STORY_BOSS_IDS_SET = new ReadonlySet([
-  BossID.MOM, // 6
-  BossID.MOMS_HEART, // 8
-  BossID.SATAN, // 24
-  BossID.IT_LIVES, // 25
-  BossID.ISAAC, // 39
-  BossID.BLUE_BABY, // 40
-  BossID.LAMB, // 54
-  BossID.MEGA_SATAN, // 55
-  BossID.ULTRA_GREED, // 62
-  BossID.HUSH, // 63
-  BossID.DELIRIUM, // 70
-  BossID.ULTRA_GREEDIER, // 71
-  BossID.MOTHER, // 88
-  BossID.MAUSOLEUM_MOM, // 89
-  BossID.MAUSOLEUM_MOMS_HEART, // 90
-  BossID.DOGMA, // 99
-  BossID.BEAST, // 100
-]);
-
-export const STORY_BOSS_ENTITY_TYPES_SET = new ReadonlySet<EntityType>([
-  EntityType.MOM, // 45
-  EntityType.MOMS_HEART, // 78
-  EntityType.SATAN, // 84
-  EntityType.ISAAC, // 102
-  EntityType.LAMB, // 273
-  EntityType.MEGA_SATAN, // 274
-  EntityType.MEGA_SATAN_2, // 275
-  EntityType.ULTRA_GREED, // 406 (includes Ultra Greedier)
-  EntityType.HUSH, // 407
-  EntityType.DELIRIUM, // 412
-  EntityType.MOTHER, // 912
-  EntityType.DOGMA, // 950
-  EntityType.BEAST, // 951
-]);
-
 export const ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET = new ReadonlySet(
-  [...ALL_BOSSES_SET].filter((bossID) => !STORY_BOSS_IDS_SET.has(bossID)),
+  [...ALL_BOSSES_SET].filter((bossID) => !isStoryBossID(bossID)),
 );