isaacscript-common 8.4.6 → 8.5.0

package/dist/functions/trinketSet.lua

@@ -8,42 +8,42 @@ local ____firstLast = require("features.firstLast")
 local getModdedTrinketTypes = ____firstLast.getModdedTrinketTypes
 local ____trinkets = require("functions.trinkets")
 local getVanillaTrinketTypes = ____trinkets.getVanillaTrinketTypes
-local ALL_TRINKETS_ARRAY = {}
-local ALL_TRINKETS_SET = __TS__New(Set)
-local VANILLA_TRINKETS_ARRAY = {}
-local VANILLA_TRINKETS_SET = __TS__New(Set)
-local MODDED_TRINKETS_ARRAY = {}
-local MODDED_TRINKETS_SET = __TS__New(Set)
-local function lazyInitVanillaTrinkets(self)
-    if #VANILLA_TRINKETS_ARRAY > 0 then
+local ALL_TRINKET_TYPES_ARRAY = {}
+local ALL_TRINKET_TYPES_SET = __TS__New(Set)
+local VANILLA_TRINKET_TYPES_ARRAY = {}
+local VANILLA_TRINKET_TYPES_SET = __TS__New(Set)
+local MODDED_TRINKET_TYPES_ARRAY = {}
+local MODDED_TRINKET_TYPES_SET = __TS__New(Set)
+local function lazyInitVanillaTrinketTypes(self)
+    if #VANILLA_TRINKET_TYPES_ARRAY > 0 then
         return
     end
     local vanillaTrinketTypes = getVanillaTrinketTypes(nil)
     for ____, trinketType in ipairs(vanillaTrinketTypes) do
         local itemConfigItem = itemConfig:GetTrinket(trinketType)
         if itemConfigItem ~= nil then
-            VANILLA_TRINKETS_ARRAY[#VANILLA_TRINKETS_ARRAY + 1] = trinketType
-            VANILLA_TRINKETS_SET:add(trinketType)
+            VANILLA_TRINKET_TYPES_ARRAY[#VANILLA_TRINKET_TYPES_ARRAY + 1] = trinketType
+            VANILLA_TRINKET_TYPES_SET:add(trinketType)
         end
     end
 end
-local function lazyInitModdedTrinkets(self)
-    if #MODDED_TRINKETS_ARRAY > 0 then
+local function lazyInitModdedTrinketTypes(self)
+    if #MODDED_TRINKET_TYPES_ARRAY > 0 then
         return
     end
-    lazyInitVanillaTrinkets(nil)
-    for ____, trinketType in ipairs(VANILLA_TRINKETS_ARRAY) do
-        ALL_TRINKETS_ARRAY[#ALL_TRINKETS_ARRAY + 1] = trinketType
-        ALL_TRINKETS_SET:add(trinketType)
+    lazyInitVanillaTrinketTypes(nil)
+    for ____, trinketType in ipairs(VANILLA_TRINKET_TYPES_ARRAY) do
+        ALL_TRINKET_TYPES_ARRAY[#ALL_TRINKET_TYPES_ARRAY + 1] = trinketType
+        ALL_TRINKET_TYPES_SET:add(trinketType)
     end
     local moddedTrinketTypes = getModdedTrinketTypes(nil)
     for ____, trinketType in ipairs(moddedTrinketTypes) do
         local itemConfigItem = itemConfig:GetTrinket(trinketType)
         if itemConfigItem ~= nil then
-            MODDED_TRINKETS_ARRAY[#MODDED_TRINKETS_ARRAY + 1] = trinketType
-            MODDED_TRINKETS_SET:add(trinketType)
-            ALL_TRINKETS_ARRAY[#ALL_TRINKETS_ARRAY + 1] = trinketType
-            ALL_TRINKETS_SET:add(trinketType)
+            MODDED_TRINKET_TYPES_ARRAY[#MODDED_TRINKET_TYPES_ARRAY + 1] = trinketType
+            MODDED_TRINKET_TYPES_SET:add(trinketType)
+            ALL_TRINKET_TYPES_ARRAY[#ALL_TRINKET_TYPES_ARRAY + 1] = trinketType
+            ALL_TRINKET_TYPES_SET:add(trinketType)
         end
     end
 end
@@ -55,8 +55,8 @@ end
 -- This function can only be called if at least one callback has been executed. This is because not
 -- all trinkets will necessarily be present when a mod first loads (due to mod load order).
 function ____exports.getModdedTrinketArray(self)
-    lazyInitModdedTrinkets(nil)
-    return MODDED_TRINKETS_ARRAY
+    lazyInitModdedTrinketTypes(nil)
+    return MODDED_TRINKET_TYPES_ARRAY
 end
 --- Returns a set containing every valid trinket type in the game, including modded trinkets.
 -- 
@@ -66,8 +66,8 @@ end
 -- This function can only be called if at least one callback has been executed. This is because not
 -- all trinkets will necessarily be present when a mod first loads (due to mod load order).
 function ____exports.getModdedTrinketSet(self)
-    lazyInitModdedTrinkets(nil)
-    return MODDED_TRINKETS_SET
+    lazyInitModdedTrinketTypes(nil)
+    return MODDED_TRINKET_TYPES_SET
 end
 --- Returns an array containing every modded trinket type in the game.
 -- 
@@ -77,8 +77,8 @@ end
 -- This function can only be called if at least one callback has been executed. This is because not
 -- all trinkets will necessarily be present when a mod first loads (due to mod load order).
 function ____exports.getTrinketArray(self)
-    lazyInitModdedTrinkets(nil)
-    return ALL_TRINKETS_ARRAY
+    lazyInitModdedTrinketTypes(nil)
+    return ALL_TRINKET_TYPES_ARRAY
 end
 --- Returns a set containing every modded trinket type in the game.
 -- 
@@ -88,23 +88,23 @@ end
 -- This function can only be called if at least one callback has been executed. This is because not
 -- all trinkets will necessarily be present when a mod first loads (due to mod load order).
 function ____exports.getTrinketSet(self)
-    lazyInitModdedTrinkets(nil)
-    return ALL_TRINKETS_SET
+    lazyInitModdedTrinketTypes(nil)
+    return ALL_TRINKET_TYPES_SET
 end
 --- Returns an array containing every valid vanilla trinket type in the game.
 -- 
 -- Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
 -- use the `getVanillaTrinketSet` helper function instead.
 function ____exports.getVanillaTrinketArray(self)
-    lazyInitVanillaTrinkets(nil)
-    return VANILLA_TRINKETS_ARRAY
+    lazyInitVanillaTrinketTypes(nil)
+    return VANILLA_TRINKET_TYPES_ARRAY
 end
 --- Returns a set containing every valid vanilla trinket type in the game.
 -- 
 -- Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
 -- use the `getVanillaTrinketArray` helper function instead.
 function ____exports.getVanillaTrinketSet(self)
-    lazyInitVanillaTrinkets(nil)
-    return VANILLA_TRINKETS_SET
+    lazyInitVanillaTrinketTypes(nil)
+    return VANILLA_TRINKET_TYPES_SET
 end
 return ____exports

package/dist/index.d.ts

@@ -294,23 +294,6 @@ export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlo
  */
 export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T> | ReadonlySet<T>>): void;
 
-/**
- * Helper function to add a stat to a player based on the `CacheFlag` provided. Call this function
- * from the `EVALUATE_CACHE` callback.
- *
- * Note that for `CacheFlag.FIRE_DELAY`, the "amount" argument will be interpreted as the tear stat
- * to add (and not the amount to mutate `EntityPlayer.MaxFireDelay` by).
- *
- * This function supports the following cache flags:
- * - CacheFlag.DAMAGE (1 << 0)
- * - CacheFlag.FIRE_DELAY (1 << 1)
- * - CacheFlag.SHOT_SPEED (1 << 2)
- * - CacheFlag.RANGE (1 << 3)
- * - CacheFlag.SPEED (1 << 4)
- * - CacheFlag.LUCK (1 << 10)
- */
-export declare function addStat(player: EntityPlayer, cacheFlag: CacheFlag, amount: number): void;
-
 /**
  * - Converts the specified amount of tears stat into the format of `EntityPlayer.MaxFireDelay` and
  *   adds it to the player.
@@ -2298,8 +2281,11 @@ export declare function getAliveNPCs(entityType?: EntityType, variant?: number,
  * The set contains strings with the entity type and variant, separated by a period.
  *
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
+ *
+ * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!
+ *                           Default is true.
  */
-export declare function getAllBossesSet(): Set<string>;
+export declare function getAllBossesSet(includeStoryBosses?: boolean): ReadonlySet<string>;
 
 /**
  * Helper function to get an array with every valid card sub-type. This includes modded cards.
@@ -2739,7 +2725,7 @@ export declare function getCollectibleSet(): ReadonlySet<CollectibleType>;
  * This function can only be called if at least one callback has been executed. This is because not
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
-export declare function getCollectiblesForCacheFlag(cacheFlag: CacheFlag): Set<CollectibleType>;
+export declare function getCollectiblesForCacheFlag(cacheFlag: CacheFlag): ReadonlySet<CollectibleType>;
 
 /**
  * Helper function to get the remaining collectibles in a given item pool. This function is
@@ -2770,7 +2756,7 @@ export declare function getCollectibleTags(collectibleType: CollectibleType): Bi
  * const guppyCollectibleTypes = getCollectibleTypesForTransformation(PlayerForm.GUPPY);
  * ```
  */
-export declare function getCollectibleTypesForTransformation(playerForm: PlayerForm): Set<CollectibleType>;
+export declare function getCollectibleTypesForTransformation(playerForm: PlayerForm): ReadonlySet<CollectibleType>;
 
 /**
  * Helper function to get all of the collectible types in the game that have a certain tag.
@@ -2782,7 +2768,7 @@ export declare function getCollectibleTypesForTransformation(playerForm: PlayerF
  * const offensiveCollectibleTypes = getCollectibleTypesWithTag(ItemConfigTag.OFFENSIVE);
  * ```
  */
-export declare function getCollectibleTypesWithTag(itemConfigTag: ItemConfigTag): Set<CollectibleType>;
+export declare function getCollectibleTypesWithTag(itemConfigTag: ItemConfigTag): ReadonlySet<CollectibleType>;
 
 /**
  * Gets the entities that have a hitbox that overlaps with any part of the square that the grid
@@ -2802,7 +2788,7 @@ export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntit
  *
  * Also see the `getAllBossesSet` and `getBossSet` functions.
  */
-export declare function getCombinedBossSet(stage: int): Set<string> | undefined;
+export declare function getCombinedBossSet(stage: int): ReadonlySet<string> | undefined;
 
 /**
  * Helper function to get all of the crawl spaces in the room.
@@ -2903,7 +2889,7 @@ export declare function getDoorSlotsForRoomShape(roomShape: RoomShape): Readonly
  */
 export declare function getDoorsToRoomIndex(...roomGridIndex: int[]): GridEntityDoor[];
 
-export declare function getEdenPassives(): Set<CollectibleType>;
+export declare function getEdenPassives(): ReadonlySet<CollectibleType>;
 
 /**
  * Helper function to account for Repentance floors being offset by 1. For example, Downpour 2 is
@@ -3169,7 +3155,7 @@ export declare function getFloorDisplayFlags(): Map<int, BitFlags<DisplayFlag>>;
  * @param pruneConditionalItems Whether or not collectibles that only grant flight conditionally
  *                              should be included in the set (like Empty Vessel).
  */
-export declare function getFlyingCollectibles(pruneConditionalItems: boolean): Set<CollectibleType>;
+export declare function getFlyingCollectibles(pruneConditionalItems: boolean): ReadonlySet<CollectibleType>;
 
 /**
  * Returns a set of all of the trinkets that grant flight. (All trinkets that grant flight do so
@@ -3535,11 +3521,11 @@ export declare function getModdedCollectibleSet(): ReadonlySet<CollectibleType>;
 /**
  * Helper function to get an array that represents the all modded collectible types.
  *
- * This function is only useful when building collectible type objects. For most purposes, you
- * should use the `getModdedCollectibleSet` helper function instead.
- *
  * Returns an empty array if there are no modded collectible types.
  *
+ * This function is only useful when building collectible type objects. For most purposes, you
+ * should use the `getModdedCollectibleArray` or `getModdedCollectibleSet` helper function instead.
+ *
  * (This function is named differently from the `getVanillaCollectibleTypeRange` function because
  * all modded collectible types are contiguous. Thus, each value represents a real
  * `CollectibleType`.)
@@ -3586,12 +3572,15 @@ export declare function getModdedTrinketSet(): ReadonlySet<TrinketType>;
  *
  * Returns an empty array if there are no modded trinket types.
  *
+ * This function is only useful when building collectible type objects. For most purposes, you
+ * should use the `getModdedCollectibleArray` or `getModdedCollectibleSet` helper function instead.
+ *
  * This function can only be called if at least one callback has been executed. This is because not
  * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedTrinketTypes(): TrinketType[];
 
-export declare function getMoveActions(): Set<ButtonAction>;
+export declare function getMoveActions(): ReadonlySet<ButtonAction>;
 
 /**
  * Helper function to get the first player with the lowest frame count. Useful to find a freshly
@@ -4836,7 +4825,7 @@ export declare function getScreenTopRightPos(): Vector;
  */
 export declare function getSetCombinations<T>(set: Set<T> | ReadonlySet<T>, includeEmptyArray: boolean): ReadonlyArray<ReadonlySet<T>>;
 
-export declare function getShootActions(): Set<ButtonAction>;
+export declare function getShootActions(): ReadonlySet<ButtonAction>;
 
 /**
  * Helper function to get all of the slots in the room.
@@ -5065,7 +5054,7 @@ export declare function getTrinketSet(): ReadonlySet<TrinketType>;
  * This function can only be called if at least one callback has been executed. This is because not
  * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
-export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): Set<TrinketType>;
+export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): ReadonlySet<TrinketType>;
 
 /**
  * Helper function to get an array that contains every trinket type.

package/dist/sets/bossSets.d.ts

@@ -2,4 +2,5 @@
 export declare const STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP: ReadonlyMap<int, ReadonlyMap<int, ReadonlySet<string>>>;
 export declare const STAGE_TO_COMBINED_BOSS_SET_MAP: ReadonlyMap<int, ReadonlySet<string>>;
 export declare const ALL_BOSSES_SET: ReadonlySet<string>;
+export declare const ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET: ReadonlySet<string>;
 //# 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":";AA2aA,eAAO,MAAM,mCAAmC,EAAE,WAAW,CAC3D,GAAG,EACH,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAarC,CAAC;AAEH,eAAO,MAAM,8BAA8B,EAAE,WAAW,CACtD,GAAG,EACH,WAAW,CAAC,MAAM,CAAC,CAanB,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,WAAW,CAAC,MAAM,CAQ7C,CAAC"}
+{"version":3,"file":"bossSets.d.ts","sourceRoot":"","sources":["../../src/sets/bossSets.ts"],"names":[],"mappings":";AAibA,eAAO,MAAM,mCAAmC,EAAE,WAAW,CAC3D,GAAG,EACH,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAarC,CAAC;AAEH,eAAO,MAAM,8BAA8B,EAAE,WAAW,CACtD,GAAG,EACH,WAAW,CAAC,MAAM,CAAC,CAanB,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,WAAW,CAAC,MAAM,CAQ7C,CAAC;AAiBH,eAAO,MAAM,qCAAqC,EAAE,WAAW,CAAC,MAAM,CACpC,CAAC"}

package/dist/sets/bossSets.lua

@@ -37,6 +37,12 @@ local SatanVariant = ____isaac_2Dtypescript_2Ddefinitions.SatanVariant
 local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
 local WarVariant = ____isaac_2Dtypescript_2Ddefinitions.WarVariant
 local WidowVariant = ____isaac_2Dtypescript_2Ddefinitions.WidowVariant
+local ____entities = require("functions.entities")
+local parseEntityTypeVariantString = ____entities.parseEntityTypeVariantString
+local ____set = require("functions.set")
+local copySet = ____set.copySet
+local ____storyBossesSet = require("sets.storyBossesSet")
+local STORY_BOSSES_SET = ____storyBossesSet.STORY_BOSSES_SET
 --- Contains just the bosses in Basement (not e.g. Burning Basement).
 local BASEMENT_BOSSES_SET = __TS__New(
     Set,
@@ -551,4 +557,17 @@ ____exports.ALL_BOSSES_SET = __TS__New(
     ____Set_13,
     {__TS__SparseArraySpread(____array_12)}
 )
+local allBossesExcludingStoryBossesSet = copySet(nil, ____exports.ALL_BOSSES_SET)
+local allBosses = {__TS__Spread(____exports.ALL_BOSSES_SET:values())}
+for ____, entityTypeVariantString in ipairs(allBosses) do
+    local tuple = parseEntityTypeVariantString(nil, entityTypeVariantString)
+    if tuple == nil then
+        error("Failed to parse a boss tuple when constructing the story boss set.")
+    end
+    local entityType, _variant = table.unpack(tuple)
+    if STORY_BOSSES_SET:has(entityType) then
+        allBossesExcludingStoryBossesSet:delete(entityTypeVariantString)
+    end
+end
+____exports.ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET = allBossesExcludingStoryBossesSet
 return ____exports

package/package.json

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

package/src/features/characterStats.ts

@@ -10,8 +10,7 @@ import {
   PlayerType,
 } from "isaac-typescript-definitions";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { addStat } from "../functions/players";
-import { getDefaultPlayerStat } from "../functions/stats";
+import { addStat, getDefaultPlayerStat } from "../functions/stats";
 
 const FEATURE_NAME = "characterStats";
 

package/src/features/firstLast.ts

@@ -95,11 +95,11 @@ export function getLastCollectibleType(): CollectibleType {
 /**
  * Helper function to get an array that represents the all modded collectible types.
  *
- * This function is only useful when building collectible type objects. For most purposes, you
- * should use the `getModdedCollectibleSet` helper function instead.
- *
  * Returns an empty array if there are no modded collectible types.
  *
+ * This function is only useful when building collectible type objects. For most purposes, you
+ * should use the `getModdedCollectibleArray` or `getModdedCollectibleSet` helper function instead.
+ *
  * (This function is named differently from the `getVanillaCollectibleTypeRange` function because
  * all modded collectible types are contiguous. Thus, each value represents a real
  * `CollectibleType`.)
@@ -189,6 +189,9 @@ export function getLastTrinketType(): TrinketType {
  *
  * Returns an empty array if there are no modded trinket types.
  *
+ * This function is only useful when building collectible type objects. For most purposes, you
+ * should use the `getModdedCollectibleArray` or `getModdedCollectibleSet` helper function instead.
+ *
  * This function can only be called if at least one callback has been executed. This is because not
  * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */

package/src/functions/bosses.ts

@@ -5,6 +5,7 @@ import {
 } from "isaac-typescript-definitions";
 import { VectorZero } from "../core/constants";
 import {
+  ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET,
   ALL_BOSSES_SET,
   STAGE_TO_COMBINED_BOSS_SET_MAP,
   STAGE_TO_STAGE_TYPE_TO_BOSS_SET_MAP,
@@ -13,7 +14,6 @@ import { SIN_ENTITY_TYPES_SET } from "../sets/sinEntityTypesSet";
 import { getNPCs, spawnNPC } from "./entitiesSpecific";
 import { getAliveNPCs } from "./npcs";
 import { isRNG } from "./rng";
-import { copySet } from "./set";
 import { asNumber } from "./types";
 import { repeat } from "./utils";
 
@@ -57,9 +57,16 @@ export function getAliveBosses(
  * The set contains strings with the entity type and variant, separated by a period.
  *
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
+ *
+ * @param includeStoryBosses Optional. Whether to include "story" bosses like Mom and It Lives!
+ *                           Default is true.
  */
-export function getAllBossesSet(): Set<string> {
-  return copySet(ALL_BOSSES_SET);
+export function getAllBossesSet(
+  includeStoryBosses = true,
+): ReadonlySet<string> {
+  return includeStoryBosses
+    ? ALL_BOSSES_SET
+    : ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET;
 }
 
 /**
@@ -84,7 +91,7 @@ export function getBossSet(
     return undefined;
   }
 
-  return copySet(bossSet);
+  return bossSet;
 }
 
 /**
@@ -117,13 +124,15 @@ export function getBosses(
  *
  * Also see the `getAllBossesSet` and `getBossSet` functions.
  */
-export function getCombinedBossSet(stage: int): Set<string> | undefined {
+export function getCombinedBossSet(
+  stage: int,
+): ReadonlySet<string> | undefined {
   const bossSet = STAGE_TO_COMBINED_BOSS_SET_MAP.get(stage);
   if (bossSet === undefined) {
     return undefined;
   }
 
-  return copySet(bossSet);
+  return bossSet;
 }
 
 /** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */

package/src/functions/collectibleCacheFlag.ts

@@ -3,7 +3,7 @@ import { itemConfig } from "../core/cachedClasses";
 import { getCollectibleArray } from "./collectibleSet";
 import { getEnumValues } from "./enums";
 import { hasFlag } from "./flag";
-import { copySet, getSortedSetValues } from "./set";
+import { getSortedSetValues } from "./set";
 import { repeat } from "./utils";
 
 const CACHE_FLAG_TO_COLLECTIBLES_MAP = new Map<
@@ -51,7 +51,7 @@ export function collectibleHasCacheFlag(
  */
 export function getCollectiblesForCacheFlag(
   cacheFlag: CacheFlag,
-): Set<CollectibleType> {
+): ReadonlySet<CollectibleType> {
   lazyInitCacheFlagMap();
 
   const collectiblesSet = CACHE_FLAG_TO_COLLECTIBLES_MAP.get(cacheFlag);
@@ -59,7 +59,7 @@ export function getCollectiblesForCacheFlag(
     return new Set();
   }
 
-  return copySet(collectiblesSet);
+  return collectiblesSet;
 }
 
 /**

package/src/functions/collectibleSet.ts

@@ -3,17 +3,17 @@ import { itemConfig } from "../core/cachedClasses";
 import { getModdedCollectibleTypes } from "../features/firstLast";
 import { getVanillaCollectibleTypeRange } from "./collectibles";
 
-const ALL_COLLECTIBLES_ARRAY: CollectibleType[] = [];
-const ALL_COLLECTIBLES_SET = new Set<CollectibleType>();
+const ALL_COLLECTIBLE_TYPES_ARRAY: CollectibleType[] = [];
+const ALL_COLLECTIBLE_TYPES_SET = new Set<CollectibleType>();
 
-const VANILLA_COLLECTIBLES_ARRAY: CollectibleType[] = [];
-const VANILLA_COLLECTIBLES_SET = new Set<CollectibleType>();
+const VANILLA_COLLECTIBLE_TYPES_ARRAY: CollectibleType[] = [];
+const VANILLA_COLLECTIBLE_TYPES_SET = new Set<CollectibleType>();
 
-const MODDED_COLLECTIBLES_ARRAY: CollectibleType[] = [];
-const MODDED_COLLECTIBLES_SET = new Set<CollectibleType>();
+const MODDED_COLLECTIBLE_TYPES_ARRAY: CollectibleType[] = [];
+const MODDED_COLLECTIBLE_TYPES_SET = new Set<CollectibleType>();
 
-function lazyInitVanillaCollectibles() {
-  if (VANILLA_COLLECTIBLES_ARRAY.length > 0) {
+function lazyInitVanillaCollectibleTypes() {
+  if (VANILLA_COLLECTIBLE_TYPES_ARRAY.length > 0) {
     return;
   }
 
@@ -22,22 +22,22 @@ function lazyInitVanillaCollectibles() {
     // Vanilla collectible types are not contiguous, so we must check every value.
     const itemConfigItem = itemConfig.GetCollectible(collectibleType);
     if (itemConfigItem !== undefined) {
-      VANILLA_COLLECTIBLES_ARRAY.push(collectibleType);
-      VANILLA_COLLECTIBLES_SET.add(collectibleType);
+      VANILLA_COLLECTIBLE_TYPES_ARRAY.push(collectibleType);
+      VANILLA_COLLECTIBLE_TYPES_SET.add(collectibleType);
     }
   }
 }
 
-function lazyInitModdedCollectibles() {
-  if (MODDED_COLLECTIBLES_ARRAY.length > 0) {
+function lazyInitModdedCollectibleTypes() {
+  if (MODDED_COLLECTIBLE_TYPES_ARRAY.length > 0) {
     return;
   }
 
-  lazyInitVanillaCollectibles();
+  lazyInitVanillaCollectibleTypes();
 
-  for (const collectibleType of VANILLA_COLLECTIBLES_ARRAY) {
-    ALL_COLLECTIBLES_ARRAY.push(collectibleType);
-    ALL_COLLECTIBLES_SET.add(collectibleType);
+  for (const collectibleType of VANILLA_COLLECTIBLE_TYPES_ARRAY) {
+    ALL_COLLECTIBLE_TYPES_ARRAY.push(collectibleType);
+    ALL_COLLECTIBLE_TYPES_SET.add(collectibleType);
   }
 
   const moddedCollectibleTypes = getModdedCollectibleTypes();
@@ -45,11 +45,11 @@ function lazyInitModdedCollectibles() {
     // Modded collectible types are contiguous, but we check every value just in case.
     const itemConfigItem = itemConfig.GetCollectible(collectibleType);
     if (itemConfigItem !== undefined) {
-      MODDED_COLLECTIBLES_ARRAY.push(collectibleType);
-      MODDED_COLLECTIBLES_SET.add(collectibleType);
+      MODDED_COLLECTIBLE_TYPES_ARRAY.push(collectibleType);
+      MODDED_COLLECTIBLE_TYPES_SET.add(collectibleType);
 
-      ALL_COLLECTIBLES_ARRAY.push(collectibleType);
-      ALL_COLLECTIBLES_SET.add(collectibleType);
+      ALL_COLLECTIBLE_TYPES_ARRAY.push(collectibleType);
+      ALL_COLLECTIBLE_TYPES_SET.add(collectibleType);
     }
   }
 }
@@ -65,8 +65,8 @@ function lazyInitModdedCollectibles() {
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getCollectibleArray(): readonly CollectibleType[] {
-  lazyInitModdedCollectibles();
-  return ALL_COLLECTIBLES_ARRAY;
+  lazyInitModdedCollectibleTypes();
+  return ALL_COLLECTIBLE_TYPES_ARRAY;
 }
 
 /**
@@ -79,8 +79,8 @@ export function getCollectibleArray(): readonly CollectibleType[] {
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getCollectibleSet(): ReadonlySet<CollectibleType> {
-  lazyInitModdedCollectibles();
-  return ALL_COLLECTIBLES_SET;
+  lazyInitModdedCollectibleTypes();
+  return ALL_COLLECTIBLE_TYPES_SET;
 }
 
 /**
@@ -93,8 +93,8 @@ export function getCollectibleSet(): ReadonlySet<CollectibleType> {
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getModdedCollectibleArray(): readonly CollectibleType[] {
-  lazyInitModdedCollectibles();
-  return MODDED_COLLECTIBLES_ARRAY;
+  lazyInitModdedCollectibleTypes();
+  return MODDED_COLLECTIBLE_TYPES_ARRAY;
 }
 
 /**
@@ -107,8 +107,8 @@ export function getModdedCollectibleArray(): readonly CollectibleType[] {
  * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export function getModdedCollectibleSet(): ReadonlySet<CollectibleType> {
-  lazyInitModdedCollectibles();
-  return MODDED_COLLECTIBLES_SET;
+  lazyInitModdedCollectibleTypes();
+  return MODDED_COLLECTIBLE_TYPES_SET;
 }
 
 /**
@@ -118,8 +118,8 @@ export function getModdedCollectibleSet(): ReadonlySet<CollectibleType> {
  * then use the `getVanillaCollectibleSet` helper function instead.
  */
 export function getVanillaCollectibleArray(): readonly CollectibleType[] {
-  lazyInitVanillaCollectibles();
-  return VANILLA_COLLECTIBLES_ARRAY;
+  lazyInitVanillaCollectibleTypes();
+  return VANILLA_COLLECTIBLE_TYPES_ARRAY;
 }
 
 /**
@@ -129,6 +129,6 @@ export function getVanillaCollectibleArray(): readonly CollectibleType[] {
  * then use the `getVanillaCollectibleArray` helper function instead.
  */
 export function getVanillaCollectibleSet(): ReadonlySet<CollectibleType> {
-  lazyInitVanillaCollectibles();
-  return VANILLA_COLLECTIBLES_SET;
+  lazyInitVanillaCollectibleTypes();
+  return VANILLA_COLLECTIBLE_TYPES_SET;
 }

package/src/functions/collectibleTag.ts

@@ -4,7 +4,6 @@ import { getCollectibleArray } from "./collectibleSet";
 import { getEnumValues } from "./enums";
 import { getFlagName } from "./flag";
 import { getPlayerCollectibleCount } from "./players";
-import { copySet } from "./set";
 
 const TAG_TO_COLLECTIBLE_TYPES_MAP = new Map<
   ItemConfigTag,
@@ -59,7 +58,7 @@ export function collectibleHasTag(
  */
 export function getCollectibleTypesWithTag(
   itemConfigTag: ItemConfigTag,
-): Set<CollectibleType> {
+): ReadonlySet<CollectibleType> {
   // Lazy initialize the map.
   if (TAG_TO_COLLECTIBLE_TYPES_MAP.size === 0) {
     initTagMap();
@@ -72,7 +71,7 @@ export function getCollectibleTypesWithTag(
     );
   }
 
-  return copySet(collectibleTypes);
+  return collectibleTypes;
 }
 
 /** Returns the number of items that a player has towards a particular transformation. */

package/src/functions/eden.ts

@@ -3,7 +3,7 @@ import { isHiddenCollectible, isPassiveCollectible } from "./collectibles";
 import { getCollectibleArray } from "./collectibleSet";
 import { collectibleHasTag } from "./collectibleTag";
 import { getRandomSeed } from "./rng";
-import { copySet, getRandomSetElement } from "./set";
+import { getRandomSetElement } from "./set";
 
 const EDEN_PASSIVE_COLLECTIBLES_SET = new Set<CollectibleType>();
 
@@ -19,13 +19,13 @@ function initCollectibleSet() {
   }
 }
 
-export function getEdenPassives(): Set<CollectibleType> {
+export function getEdenPassives(): ReadonlySet<CollectibleType> {
   // Lazy initialize the set.
   if (EDEN_PASSIVE_COLLECTIBLES_SET.size === 0) {
     initCollectibleSet();
   }
 
-  return copySet(EDEN_PASSIVE_COLLECTIBLES_SET);
+  return EDEN_PASSIVE_COLLECTIBLES_SET;
 }
 
 export function getRandomEdenPassive(

package/src/functions/flying.ts

@@ -47,11 +47,11 @@ const CONDITIONAL_FLYING_COLLECTIBLE_TYPES: readonly CollectibleType[] = [
  */
 export function getFlyingCollectibles(
   pruneConditionalItems: boolean,
-): Set<CollectibleType> {
+): ReadonlySet<CollectibleType> {
   // Instead of manually compiling a list of collectibles that grant flying, we can instead
   // dynamically look for collectibles that have `CacheFlag.FLYING`.
-  const collectiblesWithFlyingCacheFlag = getCollectiblesForCacheFlag(
-    CacheFlag.FLYING,
+  const collectiblesWithFlyingCacheFlag = copySet(
+    getCollectiblesForCacheFlag(CacheFlag.FLYING),
   );
 
   // None of the collectibles with a cache of "all" grant flying, so we can safely remove them from
@@ -80,7 +80,7 @@ export function getFlyingCollectibles(
 export function getFlyingTrinkets(): ReadonlySet<TrinketType> {
   // We use a different algorithm than the "getFlyingCollectibles" function because Azazel's Stump
   // has a cache of "all".
-  return copySet(FLYING_TRINKETS);
+  return FLYING_TRINKETS;
 }
 
 export function hasFlyingTemporaryEffect(player: EntityPlayer): boolean {