isaacscript-common 7.18.0 → 8.1.0

package/dist/functions/trinketSet.d.ts

@@ -4,6 +4,9 @@ import { TrinketType } from "isaac-typescript-definitions";
  *
  * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
  * use the `getTrinketSet` 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 getModdedTrinketArray(): readonly TrinketType[];
 /**
@@ -11,6 +14,9 @@ export declare function getModdedTrinketArray(): readonly TrinketType[];
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
  * use the `getTrinketArray` 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 getModdedTrinketSet(): ReadonlySet<TrinketType>;
 /**
@@ -18,6 +24,9 @@ export declare function getModdedTrinketSet(): ReadonlySet<TrinketType>;
  *
  * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
  * use the `getModdedTrinketSet` 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 getTrinketArray(): readonly TrinketType[];
 /**
@@ -25,6 +34,9 @@ export declare function getTrinketArray(): readonly TrinketType[];
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
  * use the `getModdedTrinketArray` 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 getTrinketSet(): ReadonlySet<TrinketType>;
 /**
@@ -32,6 +44,9 @@ export declare function getTrinketSet(): ReadonlySet<TrinketType>;
  *
  * 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.
+ *
+ * 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 getVanillaTrinketArray(): readonly TrinketType[];
 /**
@@ -39,6 +54,9 @@ export declare function getVanillaTrinketArray(): readonly TrinketType[];
  *
  * 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.
+ *
+ * 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 getVanillaTrinketSet(): ReadonlySet<TrinketType>;
 //# sourceMappingURL=trinketSet.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trinketSet.d.ts","sourceRoot":"","sources":["../../src/functions/trinketSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAwD3D;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI,SAAS,WAAW,EAAE,CAK9D;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,WAAW,CAAC,WAAW,CAAC,CAK9D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,SAAS,WAAW,EAAE,CAKxD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC,CAKxD;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,SAAS,WAAW,EAAE,CAK/D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,WAAW,CAAC,WAAW,CAAC,CAK/D"}
+{"version":3,"file":"trinketSet.d.ts","sourceRoot":"","sources":["../../src/functions/trinketSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAyD3D;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,IAAI,SAAS,WAAW,EAAE,CAG9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,IAAI,WAAW,CAAC,WAAW,CAAC,CAG9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,IAAI,SAAS,WAAW,EAAE,CAGxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,IAAI,WAAW,CAAC,WAAW,CAAC,CAGxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,IAAI,SAAS,WAAW,EAAE,CAG/D;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,IAAI,WAAW,CAAC,WAAW,CAAC,CAG/D"}

package/dist/functions/trinketSet.lua

@@ -7,8 +7,9 @@ local ____cachedClasses = require("core.cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____constantsFirstLast = require("core.constantsFirstLast")
 local FIRST_TRINKET_TYPE = ____constantsFirstLast.FIRST_TRINKET_TYPE
-local LAST_TRINKET_TYPE = ____constantsFirstLast.LAST_TRINKET_TYPE
 local LAST_VANILLA_TRINKET_TYPE = ____constantsFirstLast.LAST_VANILLA_TRINKET_TYPE
+local ____firstLast = require("features.firstLast")
+local getLastTrinketType = ____firstLast.getLastTrinketType
 local ____utils = require("functions.utils")
 local irange = ____utils.irange
 local ALL_TRINKETS_ARRAY = {}
@@ -17,11 +18,12 @@ local MODDED_TRINKETS_ARRAY = {}
 local ALL_TRINKETS_SET = __TS__New(Set)
 local VANILLA_TRINKETS_SET = __TS__New(Set)
 local MODDED_TRINKETS_SET = __TS__New(Set)
-local function initTrinketArraysAndSets(self)
+local function lazyInitTrinketArraysAndSets(self)
     if #ALL_TRINKETS_ARRAY ~= 0 then
         return
     end
-    local trinketTypeRange = irange(nil, FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE)
+    local lastTrinketType = getLastTrinketType(nil)
+    local trinketTypeRange = irange(nil, FIRST_TRINKET_TYPE, lastTrinketType)
     for ____, trinketType in ipairs(trinketTypeRange) do
         do
             local itemConfigItem = itemConfig:GetTrinket(trinketType)
@@ -54,48 +56,66 @@ end
 -- 
 -- Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
 -- use the `getTrinketSet` 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).
 function ____exports.getModdedTrinketArray(self)
-    initTrinketArraysAndSets(nil)
+    lazyInitTrinketArraysAndSets(nil)
     return MODDED_TRINKETS_ARRAY
 end
 --- Returns a set containing every valid trinket type in the game, including modded trinkets.
 -- 
 -- Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
 -- use the `getTrinketArray` 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).
 function ____exports.getModdedTrinketSet(self)
-    initTrinketArraysAndSets(nil)
+    lazyInitTrinketArraysAndSets(nil)
     return MODDED_TRINKETS_SET
 end
 --- Returns an array containing every modded 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 `getModdedTrinketSet` 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).
 function ____exports.getTrinketArray(self)
-    initTrinketArraysAndSets(nil)
+    lazyInitTrinketArraysAndSets(nil)
     return ALL_TRINKETS_ARRAY
 end
 --- Returns a set containing every modded 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 `getModdedTrinketArray` 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).
 function ____exports.getTrinketSet(self)
-    initTrinketArraysAndSets(nil)
+    lazyInitTrinketArraysAndSets(nil)
     return ALL_TRINKETS_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.
+-- 
+-- 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.getVanillaTrinketArray(self)
-    initTrinketArraysAndSets(nil)
+    lazyInitTrinketArraysAndSets(nil)
     return VANILLA_TRINKETS_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.
+-- 
+-- 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.getVanillaTrinketSet(self)
-    initTrinketArraysAndSets(nil)
+    lazyInitTrinketArraysAndSets(nil)
     return VANILLA_TRINKETS_SET
 end
 return ____exports

package/dist/functions/trinkets.d.ts

@@ -1,4 +1,4 @@
-import { CacheFlag, TrinketType } from "isaac-typescript-definitions";
+import { TrinketType } from "isaac-typescript-definitions";
 /**
  * Helper function to get the corresponding golden trinket type from a normal trinket type.
  *
@@ -6,12 +6,6 @@ import { CacheFlag, TrinketType } from "isaac-typescript-definitions";
  * corresponds to the golden trinket sub-type for Swallowed Penny.
  */
 export declare function getGoldenTrinketType(trinketType: TrinketType): TrinketType;
-/**
- * Helper function to get an array that represents every modded trinket type.
- *
- * Returns an empty array if there are no modded trinket types.
- */
-export declare function getModdedTrinketTypes(): TrinketType[];
 /**
  * Returns the slot number corresponding to where a trinket can be safely inserted.
  *
@@ -44,8 +38,6 @@ export declare function getTrinketDescription(trinketType: TrinketType): string;
  * ```
  */
 export declare function getTrinketName(trinketType: TrinketType): string;
-/** Helper function to get an array that contains every trinket type. */
-export declare function getTrinketTypes(): TrinketType[];
 /** Helper function to get an array that represents every vanilla trinket type. */
 export declare function getVanillaTrinketTypes(): TrinketType[];
 /**
@@ -70,5 +62,4 @@ export declare function isGoldenTrinket(trinketType: TrinketType): boolean;
  *                taken by the player.
  */
 export declare function setTrinketSprite(trinket: EntityPickup, pngPath: string | undefined): void;
-export declare function trinketHasCacheFlag(trinketType: TrinketType, cacheFlag: CacheFlag): boolean;
 //# sourceMappingURL=trinkets.d.ts.map

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,EACL,SAAS,EAGT,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAgCtC;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,CAE1E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,IAAI,WAAW,EAAE,CAMrD;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,wEAAwE;AACxE,wBAAgB,eAAe,IAAI,WAAW,EAAE,CAE/C;AAED,kFAAkF;AAClF,wBAAgB,sBAAsB,IAAI,WAAW,EAAE,CAEtD;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAOhE;AAED,wBAAgB,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEjE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAeN;AAED,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT"}
+{"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,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEjE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAeN"}

package/dist/functions/trinkets.lua

@@ -6,9 +6,7 @@ local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
 local ____cachedClasses = require("core.cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____constantsFirstLast = require("core.constantsFirstLast")
-local FIRST_MODDED_TRINKET_TYPE = ____constantsFirstLast.FIRST_MODDED_TRINKET_TYPE
 local FIRST_TRINKET_TYPE = ____constantsFirstLast.FIRST_TRINKET_TYPE
-local LAST_TRINKET_TYPE = ____constantsFirstLast.LAST_TRINKET_TYPE
 local LAST_VANILLA_TRINKET_TYPE = ____constantsFirstLast.LAST_VANILLA_TRINKET_TYPE
 local ____trinketDescriptionMap = require("maps.trinketDescriptionMap")
 local DEFAULT_TRINKET_DESCRIPTION = ____trinketDescriptionMap.DEFAULT_TRINKET_DESCRIPTION
@@ -18,8 +16,6 @@ local DEFAULT_TRINKET_NAME = ____trinketNameMap.DEFAULT_TRINKET_NAME
 local TRINKET_NAME_MAP = ____trinketNameMap.TRINKET_NAME_MAP
 local ____entities = require("functions.entities")
 local getEntityID = ____entities.getEntityID
-local ____flag = require("functions.flag")
-local hasFlag = ____flag.hasFlag
 local ____pickupVariants = require("functions.pickupVariants")
 local isTrinket = ____pickupVariants.isTrinket
 local ____players = require("functions.players")
@@ -44,15 +40,6 @@ local TRINKET_SPRITE_LAYER = 0
 function ____exports.getGoldenTrinketType(self, trinketType)
     return asNumber(nil, trinketType) + GOLDEN_TRINKET_ADJUSTMENT
 end
---- Helper function to get an array that represents every modded trinket type.
--- 
--- Returns an empty array if there are no modded trinket types.
-function ____exports.getModdedTrinketTypes(self)
-    if LAST_VANILLA_TRINKET_TYPE == LAST_TRINKET_TYPE then
-        return {}
-    end
-    return irange(nil, FIRST_MODDED_TRINKET_TYPE, LAST_TRINKET_TYPE)
-end
 --- Returns the slot number corresponding to where a trinket can be safely inserted.
 -- 
 -- For example:
@@ -113,10 +100,6 @@ function ____exports.getTrinketName(self, trinketType)
     end
     return DEFAULT_TRINKET_NAME
 end
---- Helper function to get an array that contains every trinket type.
-function ____exports.getTrinketTypes(self)
-    return irange(nil, FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE)
-end
 --- Helper function to get an array that represents every vanilla trinket type.
 function ____exports.getVanillaTrinketTypes(self)
     return irange(nil, FIRST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE)
@@ -159,11 +142,4 @@ function ____exports.setTrinketSprite(self, trinket, pngPath)
         sprite:LoadGraphics()
     end
 end
-function ____exports.trinketHasCacheFlag(self, trinketType, cacheFlag)
-    local itemConfigItem = itemConfig:GetTrinket(trinketType)
-    if itemConfigItem == nil then
-        return false
-    end
-    return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
-end
 return ____exports