isaacscript-common 8.4.6 → 8.7.0

package/dist/functions/stats.lua

@@ -1,6 +1,84 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
 local ____defaultPlayerStatMap = require("maps.defaultPlayerStatMap")
 local DEFAULT_PLAYER_STAT_MAP = ____defaultPlayerStatMap.DEFAULT_PLAYER_STAT_MAP
+local ____tears = require("functions.tears")
+local addTearsStat = ____tears.addTearsStat
+local STAT_CACHE_FLAGS_SET = __TS__New(Set, {
+    CacheFlag.DAMAGE,
+    CacheFlag.FIRE_DELAY,
+    CacheFlag.SHOT_SPEED,
+    CacheFlag.RANGE,
+    CacheFlag.SPEED,
+    CacheFlag.LUCK
+})
+--- 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)
+function ____exports.addStat(self, player, cacheFlag, amount)
+    if not STAT_CACHE_FLAGS_SET:has(cacheFlag) then
+        error("You cannot add a stat to a player with the cache flag of: " .. tostring(cacheFlag))
+    end
+    repeat
+        local ____switch4 = cacheFlag
+        local ____cond4 = ____switch4 == CacheFlag.DAMAGE
+        if ____cond4 then
+            do
+                player.Damage = player.Damage + amount
+                break
+            end
+        end
+        ____cond4 = ____cond4 or ____switch4 == CacheFlag.FIRE_DELAY
+        if ____cond4 then
+            do
+                addTearsStat(nil, player, amount)
+                break
+            end
+        end
+        ____cond4 = ____cond4 or ____switch4 == CacheFlag.SHOT_SPEED
+        if ____cond4 then
+            do
+                player.ShotSpeed = player.ShotSpeed + amount
+                break
+            end
+        end
+        ____cond4 = ____cond4 or ____switch4 == CacheFlag.RANGE
+        if ____cond4 then
+            do
+                player.TearHeight = player.TearHeight + amount
+                break
+            end
+        end
+        ____cond4 = ____cond4 or ____switch4 == CacheFlag.SPEED
+        if ____cond4 then
+            do
+                player.MoveSpeed = player.MoveSpeed + amount
+                break
+            end
+        end
+        ____cond4 = ____cond4 or ____switch4 == CacheFlag.LUCK
+        if ____cond4 then
+            do
+                player.Luck = player.Luck + amount
+                break
+            end
+        end
+    until true
+end
 --- Returns the starting stat that Isaac (the default character) starts with. For example, if you
 -- pass this function `CacheFlag.DAMAGE`, it will return 3.5.
 -- 

package/dist/functions/transformations.d.ts

@@ -9,7 +9,7 @@ import { CollectibleType, PlayerForm } from "isaac-typescript-definitions";
  * const guppyCollectibleTypes = getCollectibleTypesForTransformation(PlayerForm.GUPPY);
  * ```
  */
-export declare function getCollectibleTypesForTransformation(playerForm: PlayerForm): Set<CollectibleType>;
+export declare function getCollectibleTypesForTransformation(playerForm: PlayerForm): ReadonlySet<CollectibleType>;
 /** Returns the number of items that a player has towards a particular transformation. */
 export declare function getPlayerNumCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): int;
 /** Returns a set of the player's current transformations. */

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

@@ -1 +1 @@
-{"version":3,"file":"transformations.d.ts","sourceRoot":"","sources":["../../src/functions/transformations.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEf,UAAU,EACX,MAAM,8BAA8B,CAAC;AAiCtC;;;;;;;;;GASG;AACH,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,UAAU,GACrB,GAAG,CAAC,eAAe,CAAC,CAStB;AAED,yFAAyF;AACzF,wBAAgB,yCAAyC,CACvD,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAGL;AAED,6DAA6D;AAC7D,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,UAAU,CAAC,CASjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAEpE;AAED,wBAAgB,oCAAoC,CAClD,eAAe,EAAE,eAAe,GAC/B,GAAG,CAAC,UAAU,CAAC,CAiBjB;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAQrE;AAED,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAEtE"}
+{"version":3,"file":"transformations.d.ts","sourceRoot":"","sources":["../../src/functions/transformations.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEf,UAAU,EACX,MAAM,8BAA8B,CAAC;AAiCtC;;;;;;;;;GASG;AACH,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,UAAU,GACrB,WAAW,CAAC,eAAe,CAAC,CAS9B;AAED,yFAAyF;AACzF,wBAAgB,yCAAyC,CACvD,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAGL;AAED,6DAA6D;AAC7D,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,UAAU,CAAC,CASjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAEpE;AAED,wBAAgB,oCAAoC,CAClD,eAAe,EAAE,eAAe,GAC/B,GAAG,CAAC,UAAU,CAAC,CAiBjB;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAQrE;AAED,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAEtE"}

package/dist/functions/trinketCacheFlag.d.ts

@@ -13,7 +13,7 @@ export declare function getPlayerTrinketsForCacheFlag(player: EntityPlayer, cach
  * 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 check in the item config if a given trinket has a given cache flag. */
 export declare function trinketHasCacheFlag(trinketType: TrinketType, cacheFlag: CacheFlag): boolean;
 //# sourceMappingURL=trinketCacheFlag.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trinketCacheFlag.d.ts","sourceRoot":"","sources":["../../src/functions/trinketCacheFlag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AA2BtE;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAYvB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,CAAC,CASlB;AAED,6FAA6F;AAC7F,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT"}
+{"version":3,"file":"trinketCacheFlag.d.ts","sourceRoot":"","sources":["../../src/functions/trinketCacheFlag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AA0BtE;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAYvB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,WAAW,CAAC,CAS1B;AAED,6FAA6F;AAC7F,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT"}

package/dist/functions/trinketCacheFlag.lua

@@ -15,8 +15,6 @@ local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-local ____set = require("functions.set")
-local copySet = ____set.copySet
 function lazyInitCacheFlagMap(self)
     if CACHE_FLAG_TO_TRINKETS_MAP.size > 0 then
         return
@@ -41,7 +39,7 @@ function ____exports.getTrinketsForCacheFlag(self, cacheFlag)
     if trinketsSet == nil then
         return __TS__New(Set)
     end
-    return copySet(nil, trinketsSet)
+    return trinketsSet
 end
 --- Helper function to check in the item config if a given trinket has a given cache flag.
 function ____exports.trinketHasCacheFlag(self, trinketType, cacheFlag)

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/functions/trinkets.d.ts

@@ -26,6 +26,15 @@ export declare function getOpenTrinketSlot(player: EntityPlayer): int | undefine
  * trinket type was not valid.
  */
 export declare function getTrinketDescription(trinketType: TrinketType): string;
+/**
+ * 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 declare function getTrinketGfxFilename(trinketType: TrinketType): string;
 /**
  * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
  * not valid.
@@ -51,6 +60,11 @@ export declare function hasOpenTrinketSlot(player: EntityPlayer): boolean;
 export declare function isGoldenTrinketType(trinketType: TrinketType): boolean;
 export declare function isModdedTrinketType(trinketType: TrinketType): boolean;
 export declare function isVanillaTrinketType(trinketType: TrinketType): boolean;
+/**
+ * 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 declare function newTrinketSprite(trinketType: TrinketType): Sprite;
 /**
  * Helper function to change the sprite of a trinket entity.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"trinkets.d.ts","sourceRoot":"","sources":["../../src/functions/trinkets.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EACZ,MAAM,8BAA8B,CAAC;AA6BtC;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,CAE1E;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,GAAG,SAAS,CAkBxE;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CActE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAc/D;AAED,kFAAkF;AAClF,wBAAgB,sBAAsB,IAAI,WAAW,EAAE,CAEtD;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAOhE;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAErE;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAErE;AAED,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAeN"}
+{"version":3,"file":"trinkets.d.ts","sourceRoot":"","sources":["../../src/functions/trinkets.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,WAAW,EACZ,MAAM,8BAA8B,CAAC;AA+BtC;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,CAE1E;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,GAAG,SAAS,CAkBxE;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CActE;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAOtE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAc/D;AAED,kFAAkF;AAClF,wBAAgB,sBAAsB,IAAI,WAAW,EAAE,CAEtD;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAOhE;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAErE;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAErE;AAED,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEtE;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CASjE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAeN"}

package/dist/functions/trinkets.lua

@@ -5,6 +5,8 @@ local TrinketSlot = ____isaac_2Dtypescript_2Ddefinitions.TrinketSlot
 local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
 local ____cachedClasses = require("core.cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
+local ____constants = require("core.constants")
+local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
 local ____constantsFirstLast = require("core.constantsFirstLast")
 local FIRST_TRINKET_TYPE = ____constantsFirstLast.FIRST_TRINKET_TYPE
 local LAST_VANILLA_TRINKET_TYPE = ____constantsFirstLast.LAST_VANILLA_TRINKET_TYPE
@@ -35,6 +37,7 @@ end
 -- 
 -- 1 << 15
 local GOLDEN_TRINKET_ADJUSTMENT = 32768
+local TRINKET_ANM2_PATH = "gfx/005.350_trinket.anm2"
 local TRINKET_SPRITE_LAYER = 0
 --- Helper function to get the corresponding golden trinket type from a normal trinket type.
 -- 
@@ -83,6 +86,19 @@ function ____exports.getTrinketDescription(self, trinketType)
     end
     return DEFAULT_TRINKET_DESCRIPTION
 end
+--- 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.
+function ____exports.getTrinketGfxFilename(self, trinketType)
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
+    if itemConfigItem == nil then
+        return BLIND_ITEM_PNG_PATH
+    end
+    return itemConfigItem.GfxFileName
+end
 --- Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
 -- not valid.
 -- 
@@ -125,6 +141,16 @@ end
 function ____exports.isModdedTrinketType(self, trinketType)
     return not ____exports.isVanillaTrinketType(nil, trinketType)
 end
+--- 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.
+function ____exports.newTrinketSprite(self, trinketType)
+    local sprite = Sprite()
+    sprite:Load(TRINKET_ANM2_PATH, false)
+    local gfxFileName = ____exports.getTrinketGfxFilename(nil, trinketType)
+    sprite:ReplaceSpritesheet(TRINKET_SPRITE_LAYER, gfxFileName)
+    sprite:LoadGraphics()
+    return sprite
+end
 --- Helper function to change the sprite of a trinket entity.
 -- 
 -- For more information about removing the trinket sprite, see the documentation for the

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.
@@ -2297,9 +2280,15 @@ export declare function getAliveNPCs(entityType?: EntityType, variant?: number,
  *
  * The set contains strings with the entity type and variant, separated by a period.
  *
+ * Note that this set does not include bosses that do not appear in Boss Rooms (e.g. Krampus, Uriel,
+ * and Gabriel.).
+ *
  * 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.
@@ -2606,8 +2595,12 @@ export declare function getCollectibleDevilCoinPrice(collectibleType: Collectibl
 export declare function getCollectibleDevilHeartPrice(collectibleType: CollectibleType, player: EntityPlayer): PickupPrice;
 
 /**
- * Helper function to get the path to a collectible's sprite. Returns the path to the question mark
+ * Helper function to get the path to a collectible PNG file. Returns the path to the question mark
  * sprite (i.e. from Curse of the Blind) if the provided collectible type was not valid.
+ *
+ * Note that this does not return the file name, but the full path to the collectible's PNG file.
+ * The function is named "GfxFilename" to correspond to the associated `ItemConfigItem.GfxFileName`
+ * field.
  */
 export declare function getCollectibleGfxFilename(collectibleType: CollectibleType): string;
 
@@ -2739,7 +2732,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 +2763,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 +2775,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 +2795,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 +2896,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 +3162,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 +3528,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 +3579,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
@@ -4033,9 +4029,6 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  * Helper function to get all of the collectibles that the player has gotten so far on this run, in
  * order.
  *
- * Note that this does not include active collectibles that have since been dropped for other
- * collectibles.
- *
  * In the case of inventory initialization or the case where the player rerolls their build in the
  * middle of the run (e.g. with D4), the order of the inventory will not correspond to the order
  * that the items were actually given to the player. In this case, the inventory will be in the
@@ -4047,6 +4040,10 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  * would not be updated. In vanilla, this situation would never happen, but another mod might do
  * this for some reason. (With that said, the next time that a collectible is normally added or
  * removed, it would trigger a re-scan, and the previous changes would be picked up.)
+ *
+ * @param player The player to get the inventory for.
+ * @param includeActiveCollectibles Optional. If true, will include all active collectibles. Default
+ *                                 is true.
  */
 export declare function getPlayerInventory(player: EntityPlayer, includeActiveCollectibles?: boolean): CollectibleType[];
 
@@ -4056,6 +4053,14 @@ export declare function getPlayerInventory(player: EntityPlayer, includeActiveCo
  */
 export declare function getPlayerLastHeart(player: EntityPlayer): HealthType;
 
+/**
+ * Helper function to get the last passive collectible that the player picked up. In most cases,
+ * this will be the passive that is removed when the player would use Clicker.
+ *
+ * Returns undefined if the player does not have any passive collectibles.
+ */
+export declare function getPlayerLastPassiveCollectible(player: EntityPlayer): CollectibleType | undefined;
+
 /**
  * Returns the maximum heart containers that the provided player can have. Normally, this is 12, but
  * it can change depending on the character (e.g. Keeper) and other things (e.g. Mother's Kiss).
@@ -4836,7 +4841,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.
@@ -5027,6 +5032,16 @@ export declare function getTrinketArray(): readonly TrinketType[];
  */
 export declare function getTrinketDescription(trinketType: TrinketType): string;
 
+/**
+ * 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 declare function getTrinketGfxFilename(trinketType: TrinketType): string;
+
 /**
  * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
  * not valid.
@@ -5065,7 +5080,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.
@@ -7559,7 +7574,7 @@ export declare enum ModCallbackCustom {
     POST_PLAYER_CHANGE_TYPE = 57,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is higher than
-     * what it was on the previous frame.
+     * what it was on the previous frame or when a new active collectible is acquired.
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if the collectible matches the `CollectibleType` provided.
@@ -7574,7 +7589,7 @@ export declare enum ModCallbackCustom {
     POST_PLAYER_COLLECTIBLE_ADDED = 58,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is lower than
-     * what it was on the previous frame.
+     * what it was on the previous frame or when an active collectible is no longer present.
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if the collectible matches the `CollectibleType` provided.
@@ -8130,6 +8145,12 @@ export declare const NEW_RUN_PLAYER_STARTING_POSITION: Vector;
  */
 export declare function newChargeBarSprites(maxCharges: int): ChargeBarSprites;
 
+/**
+ * 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 declare function newCollectibleSprite(collectibleType: CollectibleType): Sprite;
+
 export declare function newPickingUpItem(): PickingUpItem;
 
 /** Returns a `PlayerHealth` object with all zeros. */
@@ -8156,6 +8177,12 @@ export declare function newRNG(seed?: Seed): RNG;
  */
 export declare function newRoom(): int | undefined;
 
+/**
+ * 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 declare function newTrinketSprite(trinketType: TrinketType): Sprite;
+
 /**
  * Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
  * it is. This function requires that you provide an instantiated class of the same type, as it will

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;AAEH,eAAO,MAAM,qCAAqC,qBACX,CAAC"}

package/dist/sets/bossSets.lua

@@ -7,6 +7,7 @@ local __TS__SparseArrayPush = ____lualib.__TS__SparseArrayPush
 local __TS__SparseArraySpread = ____lualib.__TS__SparseArraySpread
 local Map = ____lualib.Map
 local ____exports = {}
+local getAllBossesExcludingStoryBossesSet
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local BigHornVariant = ____isaac_2Dtypescript_2Ddefinitions.BigHornVariant
 local ChubVariant = ____isaac_2Dtypescript_2Ddefinitions.ChubVariant
@@ -37,6 +38,27 @@ 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
+function getAllBossesExcludingStoryBossesSet(self)
+    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
+    return allBossesExcludingStoryBossesSet
+end
 --- Contains just the bosses in Basement (not e.g. Burning Basement).
 local BASEMENT_BOSSES_SET = __TS__New(
     Set,
@@ -551,4 +573,5 @@ ____exports.ALL_BOSSES_SET = __TS__New(
     ____Set_13,
     {__TS__SparseArraySpread(____array_12)}
 )
+____exports.ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET = getAllBossesExcludingStoryBossesSet(nil)
 return ____exports