isaacscript-common 80.1.0 → 80.2.1

package/dist/functions/set.lua

@@ -5,6 +5,8 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__Spread = ____lualib.__TS__Spread
 local __TS__ArraySort = ____lualib.__TS__ArraySort
+local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
+local __TS__ObjectValues = ____lualib.__TS__ObjectValues
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
 local ____ReadonlySet = require("types.ReadonlySet")
@@ -17,20 +19,45 @@ local ____types = require("functions.types")
 local isPrimitive = ____types.isPrimitive
 --- Helper function to get a sorted array based on the contents of a set.
 -- 
--- Normally, set values are returned in a random order, so use this function when the ordering of
+-- Normally, set values are returned in insertion order, so use this function when the ordering of
 -- the contents is important.
 function ____exports.getSortedSetValues(self, set)
-    local values = set:values()
-    local array = {__TS__Spread(values)}
-    local firstElement = array[1]
+    local values = {__TS__Spread(set)}
+    local firstElement = values[1]
     if firstElement ~= nil then
         local arrayType = type(firstElement)
         if not isPrimitive(nil, arrayType) then
             error(("Failed to get the sorted set values because the provided set was of type \"" .. tostring(arrayType)) .. "\". Having sets with non-primitive types doesn't make much sense in general, so you might need to rethink what you are doing.")
         end
     end
-    __TS__ArraySort(array)
-    return array
+    __TS__ArraySort(values)
+    return values
+end
+--- Helper function to convert the keys of an object to a set.
+-- 
+-- Note that the set values will be inserted in a random order, due to how `pairs` works under the
+-- hood.
+-- 
+-- Also see the `objectKeysToReadonlySet` function.
+function ____exports.objectKeysToSet(self, object)
+    local set = __TS__New(Set)
+    for ____, key in ipairs(__TS__ObjectKeys(object)) do
+        set:add(key)
+    end
+    return set
+end
+--- Helper function to convert the values of an object to a set.
+-- 
+-- Note that the set values will be inserted in a random order, due to how `pairs` works under the
+-- hood.
+-- 
+-- Also see the `objectValuesToReadonlySet` function.
+function ____exports.objectValuesToSet(self, object)
+    local set = __TS__New(Set)
+    for ____, key in ipairs(__TS__ObjectValues(object)) do
+        set:add(key)
+    end
+    return set
 end
 --- Helper function to add all of the values in one set to another set. The first set passed will be
 -- modified in place.
@@ -39,7 +66,7 @@ end
 function ____exports.addSetsToSet(self, mainSet, ...)
     local setsToAdd = {...}
     for ____, set in ipairs(setsToAdd) do
-        for ____, value in __TS__Iterator(set:values()) do
+        for ____, value in __TS__Iterator(set) do
             mainSet:add(value)
         end
     end
@@ -51,7 +78,7 @@ function ____exports.combineSets(self, ...)
     local sets = {...}
     local newSet = __TS__New(Set)
     for ____, set in ipairs(sets) do
-        for ____, value in __TS__Iterator(set:values()) do
+        for ____, value in __TS__Iterator(set) do
             newSet:add(value)
         end
     end
@@ -60,7 +87,7 @@ end
 --- Helper function to copy a set. (You can also use a Set constructor to accomplish this task.)
 function ____exports.copySet(self, oldSet)
     local newSet = __TS__New(Set)
-    for ____, value in __TS__Iterator(oldSet:values()) do
+    for ____, value in __TS__Iterator(oldSet) do
         newSet:add(value)
     end
     return newSet
@@ -72,7 +99,7 @@ end
 function ____exports.deleteSetsFromSet(self, mainSet, ...)
     local setsToRemove = {...}
     for ____, set in ipairs(setsToRemove) do
-        for ____, value in __TS__Iterator(set:values()) do
+        for ____, value in __TS__Iterator(set) do
             mainSet:delete(value)
         end
     end
@@ -119,6 +146,24 @@ function ____exports.getSetCombinations(self, set, includeEmptyArray)
         function(____, array) return __TS__New(ReadonlySet, array) end
     )
 end
+--- Helper function to convert the keys of an object to a read-only set.
+-- 
+-- Note that the set values will be inserted in a random order, due to how `pairs` works under the
+-- hood.
+-- 
+-- Also see the `objectKeysToSet` function.
+function ____exports.objectKeysToReadonlySet(self, object)
+    return ____exports.objectKeysToSet(nil, object)
+end
+--- Helper function to convert the values of an object to a read-only set.
+-- 
+-- Note that the set values will be inserted in a random order, due to how `pairs` works under the
+-- hood.
+-- 
+-- Also see the `objectValuesToSet` function.
+function ____exports.objectValuesToReadonlySet(self, object)
+    return ____exports.objectValuesToSet(nil, object)
+end
 --- Helper function to add one or more elements to a set at once without having to repeatedly call
 -- the `Set.add` method.
 -- 
@@ -143,7 +188,7 @@ function ____exports.setHas(self, set, ...)
 end
 --- Helper function to sum every value in a set together.
 function ____exports.sumSet(self, set)
-    local values = {__TS__Spread(set:values())}
+    local values = {__TS__Spread(set)}
     return sumArray(nil, values)
 end
 return ____exports

package/dist/functions/stage.lua

@@ -20,7 +20,6 @@ local ____log = require("functions.log")
 local log = ____log.log
 local ____types = require("functions.types")
 local asLevelStage = ____types.asLevelStage
-local asNumber = ____types.asNumber
 local ____utils = require("functions.utils")
 local inRange = ____utils.inRange
 --- Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
@@ -62,10 +61,7 @@ function ____exports.calculateStageTypeRepentance(self, stage)
         return StageType.REPENTANCE
     end
     local seeds = game:GetSeeds()
-    local adjustedStage = asLevelStage(
-        nil,
-        asNumber(nil, stage) + 1
-    )
+    local adjustedStage = asLevelStage(nil, stage + 1)
     local stageSeed = seeds:GetStageSeed(adjustedStage)
     local halfStageSeed = math.floor(stageSeed / 2)
     if halfStageSeed % 2 == 0 then
@@ -80,7 +76,7 @@ function ____exports.getEffectiveStage(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
     if ____exports.onRepentanceStage(nil) then
-        return asNumber(nil, stage) + 1
+        return stage + 1
     end
     return stage
 end

package/dist/functions/trinkets.lua

@@ -46,7 +46,7 @@ local TRINKET_SPRITE_LAYER = 0
 -- For example, passing `TrinketType.SWALLOWED_PENNY` would result in 32769, which is the value that
 -- corresponds to the golden trinket sub-type for Swallowed Penny.
 function ____exports.getGoldenTrinketType(self, trinketType)
-    return ____exports.isGoldenTrinketType(nil, trinketType) and trinketType or asNumber(nil, trinketType) + GOLDEN_TRINKET_ADJUSTMENT
+    return ____exports.isGoldenTrinketType(nil, trinketType) and trinketType or trinketType + GOLDEN_TRINKET_ADJUSTMENT
 end
 --- Helper function to get the current effect that the Mysterious Paper trinket is providing to the
 -- player. Returns undefined if the player does not have the Mysterious Paper trinket.
@@ -80,7 +80,7 @@ end
 -- If the provided trinket type is already a normal trinket type, then the trinket type will be
 -- returned unmodified.
 function ____exports.getNormalTrinketType(self, trinketType)
-    return ____exports.isGoldenTrinketType(nil, trinketType) and asNumber(nil, trinketType) - GOLDEN_TRINKET_ADJUSTMENT or trinketType
+    return ____exports.isGoldenTrinketType(nil, trinketType) and trinketType - GOLDEN_TRINKET_ADJUSTMENT or trinketType
 end
 --- Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
 -- trinket type was not valid.

package/dist/functions/types.d.ts

@@ -1,3 +1,32 @@
+/**
+ * Consider the following code that uses a number enum:
+ *
+ * ```ts
+ * enum MyEnum {
+ *   Value1,
+ * }
+ *
+ * function asMyEnum(num: number): MyEnum {}
+ *
+ * declare const something: unknown;
+ *
+ * const foo = something as MyEnum; // no error
+ * const bar: MyEnum = something; // error
+ * const baz = asMyEnum(something); // error
+ * ```
+ *
+ * Here, using `as` does not give an error because TypeScript allows you to assert a type to a
+ * supertype or a subtype. Thus, using `as` to perform a type assertion is not as safe as using a
+ * variable declaration or a helper function. However, if we use a variable declaration, then the
+ * `isaacscript/strict-enums` rule is triggered, which requires suppressing the lint rule with a `//
+ * eslint-disable-next-line`. Thus, the safest and more concise way to do a type assertion is to use
+ * a helper function.
+ *
+ * This file contains helper functions for various number enums that might require type assertions.
+ * It also contains helper functions for run-time type checks.
+ *
+ * @module
+ */
 /// <reference types="@typescript-to-lua/language-extensions" />
 /// <reference types="lua-types/5.3" />
 import type { CardType, CollectibleType, LevelStage, NPCState, PillColor, PillEffect, PlayerType, RoomType, TrinketType } from "isaac-typescript-definitions";

package/dist/functions/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/functions/types.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,UAAU,EACV,QAAQ,EACR,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAEtC;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,eAAe,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAEtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,WAAW,CAEnD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,OAAO,CAEhE;AAGD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,QAAQ,CAElE;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,GAAG,CAM5D;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CACzB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,OAAO,GAAG,MAAM,GAAG,MAAM,CAOvC;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,wBAAgB,OAAO,CACrB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAExC;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,WAAW,CAErE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/functions/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;;;AAEH,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,UAAU,EACV,QAAQ,EACR,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAEtC;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,eAAe,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAEtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,WAAW,CAEnD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,OAAO,CAEhE;AAGD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,QAAQ,CAElE;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,GAAG,CAM5D;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CACzB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,OAAO,GAAG,MAAM,GAAG,MAAM,CAOvC;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,wBAAgB,OAAO,CACrB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAExC;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,WAAW,CAErE"}

package/dist/index.rollup.d.ts

@@ -7874,7 +7874,7 @@ export declare function getSlots(slotVariant?: SlotVariant | -1, subType?: numbe
 /**
  * Helper function to get a sorted array based on the contents of a set.
  *
- * Normally, set values are returned in a random order, so use this function when the ordering of
+ * Normally, set values are returned in insertion order, so use this function when the ordering of
  * the contents is important.
  */
 export declare function getSortedSetValues<T>(set: Set<T> | ReadonlySet<T>): T[];
@@ -10583,24 +10583,47 @@ export declare const LAST_ROOM_TYPE: RoomType;
 
 export declare const LAST_STAGE: LevelStage;
 
-/** Calculated from the `Card` enum. */
+/**
+ * Calculated from the `CardType` enum.
+ *
+ * Note that this could be calculated from the length of the enum, because card types are
+ * contiguous. However, we instead get the highest enum value to be safer and to make the code more
+ * consistent with collectibles and trinkets.
+ */
 export declare const LAST_VANILLA_CARD_TYPE: CardType;
 
-/** Calculated from the `PlayerType` enum. */
+/**
+ * Calculated from the `PlayerType` enum.
+ *
+ * Note that this could be calculated from the length of the enum, because characters are
+ * contiguous. However, we instead get the highest enum value to be safer and to make the code more
+ * consistent with collectibles and trinkets.
+ */
 export declare const LAST_VANILLA_CHARACTER: PlayerType;
 
 /**
  * Calculated from the `CollectibleType` enum.
  *
- * Note that this cannot be calculated from the length of the enum, because unlike all of the other
- * enums, collectible types are not contiguous.
+ * Note that this cannot be calculated from the length of the enum, because collectible types are
+ * not contiguous.
  */
 export declare const LAST_VANILLA_COLLECTIBLE_TYPE: CollectibleType;
 
-/** Calculated from the `PillEffect` enum. */
+/**
+ * Calculated from the `PillEffect` enum.
+ *
+ * Note that this could be calculated from the length of the enum, because pill effects are
+ * contiguous. However, we instead get the highest enum value to be safer and to make the code more
+ * consistent with collectibles and trinkets.
+ */
 export declare const LAST_VANILLA_PILL_EFFECT: PillEffect;
 
-/** Calculated from the `TrinketType` enum. */
+/**
+ * Calculated from the `TrinketType` enum.
+ *
+ * Note that this cannot be calculated from the length of the enum, because trinket types are not
+ * contiguous.
+ */
 export declare const LAST_VANILLA_TRINKET_TYPE: TrinketType;
 
 declare type Length<T extends unknown[]> = T extends {
@@ -13623,7 +13646,7 @@ declare class ModdedElementDetection extends Feature {
      * Equal to `itemConfig.GetCollectibles().Size - 1`. (`Size` includes invalid collectibles, like
      * 666. We subtract one to account for `CollectibleType.NULL`.)
      *
-     * If there are no mods present that add any custom items, this function will return
+     * If there are no mods present that add any custom collectibles, this function will return
      * `CollectibleType.MOMS_RING` (732).
      *
      * This function can only be called if at least one callback has been executed. This is because
@@ -13638,7 +13661,7 @@ declare class ModdedElementDetection extends Feature {
     getLastCollectibleType(): CollectibleType;
     /**
      * Returns the total number of collectibles in the item config, including both vanilla and modded
-     * items. If you just need the number of vanilla collectible types, use the
+     * collectibles. If you just need the number of vanilla collectible types, use the
      * `NUM_VANILLA_COLLECTIBLE_TYPES` constant.
      *
      * This function can only be called if at least one callback has been executed. This is because
@@ -13696,7 +13719,7 @@ declare class ModdedElementDetection extends Feature {
     getLastTrinketType(): TrinketType;
     /**
      * Returns the total number of trinkets in the item config, including both vanilla and modded
-     * items. If you just need the number of vanilla trinket types, use the
+     * trinkets. If you just need the number of vanilla trinket types, use the
      * `NUM_VANILLA_TRINKET_TYPES` constant.
      *
      * This function can only be called if at least one callback has been executed. This is because
@@ -13735,11 +13758,14 @@ declare class ModdedElementDetection extends Feature {
     /**
      * Will change depending on how many modded cards there are.
      *
-     * This is equal to the number of cards, since all card sub-types are contiguous (unlike
-     * collectibles).
+     * Equal to `itemConfig.GetCards().Size - 1`. (`Size` includes invalid cards, but since cards are
+     * contiguous, there are no invalid cards. We subtract one to account for `CardType.NULL`.)
+     *
+     * If there are no mods present that add any custom cards, this function will return
+     * `CardType.SOUL_OF_JACOB_AND_ESAU` (97).
      *
      * This function can only be called if at least one callback has been executed. This is because
-     * not all cards will necessarily be present when a mod first loads (due to mod load order).
+     * not all trinkets will necessarily be present when a mod first loads (due to mod load order).
      *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.MODDED_ELEMENT_DETECTION`.
@@ -13748,9 +13774,8 @@ declare class ModdedElementDetection extends Feature {
      */
     getLastCardType(): CardType;
     /**
-     * Will change depending on how many modded cards there are.
-     *
-     * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
+     * Returns the total number of cards in the item config, including both vanilla and modded cards.
+     * If you just need the number of vanilla card types, use the `NUM_VANILLA_CARD_TYPES` constant.
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all cards will necessarily be present when a mod first loads (due to mod load order).
@@ -13762,8 +13787,10 @@ declare class ModdedElementDetection extends Feature {
      */
     getNumCardTypes(): int;
     /**
+     * Like vanilla card types, modded card types are always contiguous.
+     *
      * 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).
+     * not all cards will necessarily be present when a mod first loads (due to mod load order).
      *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.MODDED_ELEMENT_DETECTION`.
@@ -13787,8 +13814,12 @@ declare class ModdedElementDetection extends Feature {
     /**
      * Will change depending on how many modded pill effects there are.
      *
-     * This is equal to the number of pill effects, since all pill effects are contiguous (unlike
-     * collectibles).
+     * Equal to `itemConfig.GetPillEffects().Size - 1`. (`Size` includes invalid pill effects, but
+     * since pill effects are contiguous, there are no invalid pill effects. We subtract one to
+     * account for the enum starting at 0 instead of 1.)
+     *
+     * If there are no mods present that add any custom pill effects, this function will return
+     * `PillEffect.EXPERIMENTAL` (49).
      *
      * This function can only be called if at least one callback has been executed. This is because
      * not all pill effects will necessarily be present when a mod first loads (due to mod load
@@ -13801,14 +13832,12 @@ declare class ModdedElementDetection extends Feature {
      */
     getLastPillEffect(): PillEffect;
     /**
-     * Will change depending on how many modded pill effects there are.
-     *
-     * Equal to `itemConfig.GetPillEffects().Size`. (We do not have to subtract one, because the first
-     * pill effect has an ID of 0 and there is no `PillEffect.NULL`.)
+     * Returns the total number of pill effects in the item config, including both vanilla and modded
+     * pill effects. If you just need the number of vanilla pill effects, use the
+     * `NUM_VANILLA_PILL_EFFECTS` constant.
      *
      * This function can only be called if at least one callback has been executed. This is because
-     * not all pill effects will necessarily be present when a mod first loads (due to mod load
-     * order).
+     * not all cards will necessarily be present when a mod first loads (due to mod load order).
      *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.MODDED_ELEMENT_DETECTION`.
@@ -13817,9 +13846,10 @@ declare class ModdedElementDetection extends Feature {
      */
     getNumPillEffects(): int;
     /**
+     * Like vanilla pill effects, modded pill effects are always contiguous.
+     *
      * This function can only be called if at least one callback has been executed. This is because
-     * not all pill effects will necessarily be present when a mod first loads (due to mod load
-     * order).
+     * not all cards will necessarily be present when a mod first loads (due to mod load order).
      *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.MODDED_ELEMENT_DETECTION`.
@@ -14889,6 +14919,26 @@ export declare const NUM_VANILLA_PILL_EFFECTS: int;
 /** Calculated from the `TrinketType` enum. (`TrinketType.NULL` is not included.) */
 export declare const NUM_VANILLA_TRINKET_TYPES: number;
 
+/**
+ * Helper function to convert the keys of an object to a read-only set.
+ *
+ * Note that the set values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectKeysToSet` function.
+ */
+export declare function objectKeysToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<K>;
+
+/**
+ * Helper function to convert the keys of an object to a set.
+ *
+ * Note that the set values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectKeysToReadonlySet` function.
+ */
+export declare function objectKeysToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<K>;
+
 /**
  * Helper function to convert an object to a map.
  *
@@ -14919,6 +14969,26 @@ export declare function objectToMap<K extends string | number | symbol, V>(objec
  */
 export declare function objectToReadonlyMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 
+/**
+ * Helper function to convert the values of an object to a read-only set.
+ *
+ * Note that the set values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectValuesToSet` function.
+ */
+export declare function objectValuesToReadonlySet<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlySet<V>;
+
+/**
+ * Helper function to convert the values of an object to a set.
+ *
+ * Note that the set values will be inserted in a random order, due to how `pairs` works under the
+ * hood.
+ *
+ * Also see the `objectValuesToReadonlySet` function.
+ */
+export declare function objectValuesToSet<K extends string | number | symbol, V>(object: Record<K, V>): Set<V>;
+
 /** Helper function to see if the player is playing any challenge. */
 export declare function onAnyChallenge(): boolean;