isaacscript-common 8.4.6 → 8.7.0

package/src/functions/trinkets.ts

@@ -4,6 +4,7 @@ import {
   TrinketType,
 } from "isaac-typescript-definitions";
 import { itemConfig } from "../core/cachedClasses";
+import { BLIND_ITEM_PNG_PATH } from "../core/constants";
 import {
   FIRST_TRINKET_TYPE,
   LAST_VANILLA_TRINKET_TYPE,
@@ -29,6 +30,7 @@ import { irange } from "./utils";
  */
 const GOLDEN_TRINKET_ADJUSTMENT = 32768;
 
+const TRINKET_ANM2_PATH = "gfx/005.350_trinket.anm2";
 const TRINKET_SPRITE_LAYER = 0;
 
 /**
@@ -95,6 +97,23 @@ export function getTrinketDescription(trinketType: TrinketType): string {
   return DEFAULT_TRINKET_DESCRIPTION;
 }
 
+/**
+ * Helper function to get the path to a trinket PNG file. Returns the path to the question mark
+ * sprite (i.e. from Curse of the Blind) if the provided trinket type was not valid.
+ *
+ * Note that this does not return the file name, but the full path to the trinket's PNG file. The
+ * function is named "GfxFilename" to correspond to the associated `ItemConfigItem.GfxFileName`
+ * field.
+ */
+export function getTrinketGfxFilename(trinketType: TrinketType): string {
+  const itemConfigItem = itemConfig.GetTrinket(trinketType);
+  if (itemConfigItem === undefined) {
+    return BLIND_ITEM_PNG_PATH;
+  }
+
+  return itemConfigItem.GfxFileName;
+}
+
 /**
  * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
  * not valid.
@@ -155,6 +174,21 @@ export function isVanillaTrinketType(trinketType: TrinketType): boolean {
   return trinketType <= LAST_VANILLA_TRINKET_TYPE;
 }
 
+/**
+ * Helper function to generate a new sprite based on a collectible. If the provided collectible type
+ * is invalid, a sprite with a Curse of the Blind question mark will be returned.
+ */
+export function newTrinketSprite(trinketType: TrinketType): Sprite {
+  const sprite = Sprite();
+  sprite.Load(TRINKET_ANM2_PATH, false);
+
+  const gfxFileName = getTrinketGfxFilename(trinketType);
+  sprite.ReplaceSpritesheet(TRINKET_SPRITE_LAYER, gfxFileName);
+  sprite.LoadGraphics();
+
+  return sprite;
+}
+
 /**
  * Helper function to change the sprite of a trinket entity.
  *

package/src/sets/bossSets.ts

@@ -29,10 +29,16 @@ import {
   WarVariant,
   WidowVariant,
 } from "isaac-typescript-definitions";
+import { parseEntityTypeVariantString } from "../functions/entities";
+import { copySet } from "../functions/set";
+import { STORY_BOSSES_SET } from "./storyBossesSet";
 
 // The "bosspools.xml" file does not actually correspond to the real boss pools, so these sets were
 // determined through experimentation on v1.7.8a.
 
+// We use sets of strings instead of tuples for these data structures because TypeScript/Lua does
+// not have real tuples. If we store bosses as tuples, then we cannot do a set lookup in O(1).
+
 /** Contains just the bosses in Basement (not e.g. Burning Basement). */
 const BASEMENT_BOSSES_SET: ReadonlySet<string> = new Set([
   `${EntityType.LARRY_JR}.${LarryJrVariant.LARRY_JR}`, // 19.0
@@ -468,3 +474,30 @@ export const ALL_BOSSES_SET: ReadonlySet<string> = new Set([
   ...ALL_STAGE_10_BOSSES_SET.values(),
   ...ALL_STAGE_11_BOSSES_SET.values(),
 ]);
+
+export const ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET =
+  getAllBossesExcludingStoryBossesSet();
+
+/**
+ * Since story bosses are stored by entity type, we copy the existing bosses and filter them (to
+ * avoid having to hard-code story boss variants).
+ */
+function getAllBossesExcludingStoryBossesSet(): ReadonlySet<string> {
+  const allBossesExcludingStoryBossesSet = copySet(ALL_BOSSES_SET);
+  const allBosses = [...ALL_BOSSES_SET.values()];
+  for (const entityTypeVariantString of allBosses) {
+    const tuple = parseEntityTypeVariantString(entityTypeVariantString);
+    if (tuple === undefined) {
+      error(
+        "Failed to parse a boss tuple when constructing the story boss set.",
+      );
+    }
+
+    const [entityType, _variant] = tuple;
+    if (STORY_BOSSES_SET.has(entityType)) {
+      allBossesExcludingStoryBossesSet.delete(entityTypeVariantString);
+    }
+  }
+
+  return allBossesExcludingStoryBossesSet;
+}