isaacscript-common 7.12.0 → 7.15.0

package/dist/features/customPickup.d.ts

@@ -1,3 +1,24 @@
-export declare function customPickupInit(): void;
-export declare function registerCustomPickup(): void;
+import { PickupVariant } from "isaac-typescript-definitions";
+export declare function customPickupInit(mod: Mod): void;
+/**
+ * Helper function to register a custom pickup with the IsaacScript standard library. Use this
+ * feature for custom pickups that are intended to be picked up by the player, like keys and bombs.
+ *
+ * When IsaacScript detects that a player should be collecting the custom pickup, then the pickup
+ * will be immediately removed, and an effect showing the pickup's respective `Collect` animation
+ * will be spawned. (This emulates how a normal vanilla pickup would work.)
+ *
+ * Note that when you specify your custom pickup in the "entities2.xml" file, it should have a type
+ * of "5" and be associated with an anm2 file that has a "Collect" animation.
+ *
+ * @param pickupVariantCustom The variant for the corresponding custom pickup.
+ * @param subType The sub-type for the corresponding custom pickup.
+ * @param collectFunc The function to run when the player collects this pickup.
+ * @param collisionFunc Optional. The function to run when a player collides with the pickup.
+ *                      Default is a function that always returns true, meaning that the player will
+ *                      always immediately collect the pickup when they collide with it. Specify
+ *                      this function if your pickup should only be able to be collected under
+ *                      certain conditions.
+ */
+export declare function registerCustomPickup(pickupVariantCustom: PickupVariant, subType: int, collectFunc: (player: EntityPlayer) => void, collisionFunc?: (player: EntityPlayer) => boolean): void;
 //# sourceMappingURL=customPickup.d.ts.map

package/dist/features/customPickup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customPickup.d.ts","sourceRoot":"","sources":["../../src/features/customPickup.ts"],"names":[],"mappings":"AAIA,wBAAgB,gBAAgB,IAAI,IAAI,CAAG;AAE3C,wBAAgB,oBAAoB,IAAI,IAAI,CAE3C"}
+{"version":3,"file":"customPickup.d.ts","sourceRoot":"","sources":["../../src/features/customPickup.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,aAAa,EACd,MAAM,8BAA8B,CAAC;AA6BtC,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAO/C;AAuDD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAClC,mBAAmB,EAAE,aAAa,EAClC,OAAO,EAAE,GAAG,EACZ,WAAW,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,EAC3C,aAAa,GAAE,CAAC,MAAM,EAAE,YAAY,KAAK,OAAoB,GAC5D,IAAI,CAaN"}

package/dist/features/customPickup.lua

@@ -1,10 +1,85 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+local prePickupCollision, postEffectRenderPickupEffect, PICKUP_EFFECT_VARIANT, PICKUP_EFFECT_SUB_TYPE, customPickupFunctionsMap
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____entities = require("functions.entities")
+local getEntityID = ____entities.getEntityID
+local getEntityIDFromConstituents = ____entities.getEntityIDFromConstituents
+local ____entitiesSpecific = require("functions.entitiesSpecific")
+local spawnEffect = ____entitiesSpecific.spawnEffect
+function prePickupCollision(self, pickup, collider)
+    local entityID = getEntityID(nil, pickup)
+    local customPickupFunctions = customPickupFunctionsMap:get(entityID)
+    if customPickupFunctions == nil then
+        return nil
+    end
+    local player = collider:ToPlayer()
+    if player == nil then
+        return nil
+    end
+    local shouldPickup = customPickupFunctions:collisionFunc(player)
+    if not shouldPickup then
+        return nil
+    end
+    pickup:Remove()
+    local pickupSprite = pickup:GetSprite()
+    local fileName = pickupSprite:GetFilename()
+    local effect = spawnEffect(nil, PICKUP_EFFECT_VARIANT, PICKUP_EFFECT_SUB_TYPE, pickup.Position)
+    local effectSprite = effect:GetSprite()
+    effectSprite:Load(fileName, true)
+    effectSprite:Play("Collect", true)
+    customPickupFunctions:collectFunc(player)
+    return nil
+end
+function postEffectRenderPickupEffect(self, effect)
+    if effect.SubType ~= PICKUP_EFFECT_SUB_TYPE then
+        return
+    end
+    local sprite = effect:GetSprite()
+    if sprite:IsFinished("Collect") then
+        effect:Remove()
+    end
+end
 local FEATURE_NAME = "customPickup"
-function ____exports.customPickupInit(self)
+PICKUP_EFFECT_VARIANT = EffectVariant.LADDER
+PICKUP_EFFECT_SUB_TYPE = 103
+customPickupFunctionsMap = __TS__New(Map)
+function ____exports.customPickupInit(self, mod)
+    mod:AddCallback(ModCallback.PRE_PICKUP_COLLISION, prePickupCollision)
+    mod:AddCallback(ModCallback.POST_EFFECT_RENDER, postEffectRenderPickupEffect, PICKUP_EFFECT_VARIANT)
 end
-function ____exports.registerCustomPickup(self)
+--- Helper function to register a custom pickup with the IsaacScript standard library. Use this
+-- feature for custom pickups that are intended to be picked up by the player, like keys and bombs.
+-- 
+-- When IsaacScript detects that a player should be collecting the custom pickup, then the pickup
+-- will be immediately removed, and an effect showing the pickup's respective `Collect` animation
+-- will be spawned. (This emulates how a normal vanilla pickup would work.)
+-- 
+-- Note that when you specify your custom pickup in the "entities2.xml" file, it should have a type
+-- of "5" and be associated with an anm2 file that has a "Collect" animation.
+-- 
+-- @param pickupVariantCustom The variant for the corresponding custom pickup.
+-- @param subType The sub-type for the corresponding custom pickup.
+-- @param collectFunc The function to run when the player collects this pickup.
+-- @param collisionFunc Optional. The function to run when a player collides with the pickup.
+-- Default is a function that always returns true, meaning that the player will
+-- always immediately collect the pickup when they collide with it. Specify
+-- this function if your pickup should only be able to be collected under
+-- certain conditions.
+function ____exports.registerCustomPickup(self, pickupVariantCustom, subType, collectFunc, collisionFunc)
+    if collisionFunc == nil then
+        collisionFunc = function() return true end
+    end
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local entityID = getEntityIDFromConstituents(nil, EntityType.PICKUP, pickupVariantCustom, subType)
+    local customPickupFunctions = {collectFunc = collectFunc, collisionFunc = collisionFunc}
+    customPickupFunctionsMap:set(entityID, customPickupFunctions)
 end
 return ____exports

package/dist/features/customStage/backdrop.lua

@@ -2,7 +2,7 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local getBackdropPNGPath, spawnWallEntity, spawnSecondWallEntity, spawnFloorEntity, getNumFloorLayers, BackdropKind, DEFAULT_BACKDROP, ROOM_SHAPE_WALL_ANM2_LAYERS, ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS, WALL_OFFSET, L_FLOOR_ANM2_LAYERS, N_FLOOR_ANM2_LAYERS, BACKDROP_EFFECT_VARIANT, BACKDROP_EFFECT_SUBTYPE
+local getBackdropPNGPath, spawnWallEntity, spawnSecondWallEntity, spawnFloorEntity, getNumFloorLayers, BackdropKind, DEFAULT_BACKDROP, ROOM_SHAPE_WALL_ANM2_LAYERS, ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS, WALL_OFFSET, L_FLOOR_ANM2_LAYERS, N_FLOOR_ANM2_LAYERS, BACKDROP_EFFECT_VARIANT, BACKDROP_EFFECT_SUB_TYPE
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
 local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
@@ -42,7 +42,7 @@ function spawnWallEntity(self, customStage, rng, isExtraWall)
     local wallEffect = spawnEffectWithSeed(
         nil,
         BACKDROP_EFFECT_VARIANT,
-        BACKDROP_EFFECT_SUBTYPE,
+        BACKDROP_EFFECT_SUB_TYPE,
         VectorZero,
         seed
     )
@@ -181,7 +181,7 @@ WALL_OFFSET = Vector(-80, -80)
 L_FLOOR_ANM2_LAYERS = {16, 17}
 N_FLOOR_ANM2_LAYERS = {18, 19}
 BACKDROP_EFFECT_VARIANT = EffectVariant.LADDER
-BACKDROP_EFFECT_SUBTYPE = 101
+BACKDROP_EFFECT_SUB_TYPE = 101
 local BACKDROP_ROOM_TYPE_SET = __TS__New(Set, {RoomType.DEFAULT, RoomType.BOSS, RoomType.MINI_BOSS})
 function ____exports.setCustomStageBackdrop(self, customStage)
     local room = game:GetRoom()

package/dist/features/customStage/shadows.lua

@@ -21,7 +21,7 @@ local v = ____v.default
 -- We arbitrarily choose a ladder for this purpose because it will not automatically despawn after
 -- time passes, like most other effects.
 local SHADOW_EFFECT_VARIANT = EffectVariant.LADDER
-local SHADOW_EFFECT_SUBTYPE = 102
+local SHADOW_EFFECT_SUB_TYPE = 102
 --- The animation comes from StageAPI.
 local ROOM_SHAPE_TO_SHADOW_ANIMATION = {
     [RoomShape.SHAPE_1x1] = "1x1",
@@ -54,7 +54,7 @@ function ____exports.setShadows(self, customStage)
     local shadowEffect = spawnEffectWithSeed(
         nil,
         SHADOW_EFFECT_VARIANT,
-        SHADOW_EFFECT_SUBTYPE,
+        SHADOW_EFFECT_SUB_TYPE,
         centerPos,
         seed
     )

package/dist/features/deployJSONRoom.lua

@@ -40,7 +40,7 @@ local ____gridEntities = require("functions.gridEntities")
 local convertXMLGridEntityType = ____gridEntities.convertXMLGridEntityType
 local getAllGridIndexes = ____gridEntities.getAllGridIndexes
 local getGridEntities = ____gridEntities.getGridEntities
-local removeAllGridExcept = ____gridEntities.removeAllGridExcept
+local removeAllGridEntitiesExcept = ____gridEntities.removeAllGridEntitiesExcept
 local removeGridEntity = ____gridEntities.removeGridEntity
 local setGridEntityInvisible = ____gridEntities.setGridEntityInvisible
 local spawnGridEntityWithVariant = ____gridEntities.spawnGridEntityWithVariant
@@ -157,7 +157,7 @@ function ____exports.emptyRoom(self, fillWithDecorations)
     removeSpecificNPCs(nil)
     removeAllMatchingEntities(nil, EntityType.EFFECT, EffectVariant.DEVIL)
     removeAllMatchingEntities(nil, EntityType.EFFECT, EffectVariant.ANGEL)
-    removeAllGridExcept(nil, GridEntityType.WALL, GridEntityType.DOOR)
+    removeAllGridEntitiesExcept(nil, GridEntityType.WALL, GridEntityType.DOOR)
     setRoomCleared(nil)
     if fillWithDecorations then
         fillRoomWithDecorations(nil)

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

@@ -1 +1 @@
-{"version":3,"file":"collectibleSet.d.ts","sourceRoot":"","sources":["../../src/functions/collectibleSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAuD/D;;;;;;GAMG;AACH,wBAAgB,mBAAmB,IAAI,SAAS,eAAe,EAAE,CAKhE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKhE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,SAAS,eAAe,EAAE,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,SAAS,eAAe,EAAE,CAKvE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKvE"}
+{"version":3,"file":"collectibleSet.d.ts","sourceRoot":"","sources":["../../src/functions/collectibleSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAwD/D;;;;;;GAMG;AACH,wBAAgB,mBAAmB,IAAI,SAAS,eAAe,EAAE,CAKhE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKhE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,SAAS,eAAe,EAAE,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,SAAS,eAAe,EAAE,CAKvE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKvE"}

package/dist/functions/collectibleSet.lua

@@ -38,14 +38,14 @@ local function initCollectibleArraysAndSets(self)
         ::__continue4::
     end
     __TS__ArraySort(ALL_COLLECTIBLES_ARRAY)
-    __TS__ArraySort(VANILLA_COLLECTIBLES_ARRAY)
-    __TS__ArraySort(MODDED_COLLECTIBLES_ARRAY)
     for ____, collectibleType in ipairs(ALL_COLLECTIBLES_ARRAY) do
         ALL_COLLECTIBLES_SET:add(collectibleType)
     end
+    __TS__ArraySort(VANILLA_COLLECTIBLES_ARRAY)
     for ____, collectibleType in ipairs(VANILLA_COLLECTIBLES_ARRAY) do
         VANILLA_COLLECTIBLES_SET:add(collectibleType)
     end
+    __TS__ArraySort(MODDED_COLLECTIBLES_ARRAY)
     for ____, collectibleType in ipairs(MODDED_COLLECTIBLES_ARRAY) do
         MODDED_COLLECTIBLES_SET:add(collectibleType)
     end

package/dist/functions/gridEntities.d.ts

@@ -122,7 +122,7 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  * For example:
  *
  * ```ts
- * removeAllGridEntitiesExceptFor(
+ * removeAllGridEntitiesExcept(
  *   GridEntityType.WALL,
  *   GridEntityType.DOOR,
  * );
@@ -130,7 +130,7 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  *
  * @returns The grid entities that were removed.
  */
-export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]): GridEntity[];
+export declare function removeAllGridEntitiesExcept(...gridEntityTypes: GridEntityType[]): GridEntity[];
 /**
  * Helper function to remove all of the grid entities in the room that match the grid entity types
  * provided.

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

@@ -1 +1 @@
-{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAGjB,cAAc,EACd,iBAAiB,EAGjB,eAAe,EAChB,MAAM,8BAA8B,CAAC;AAStC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAgCvD;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAqBnC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;GAMG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CA4BV;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,iBAAiB,GAAE,iBAAsB,GACxC,UAAU,EAAE,CAMd;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,wFAAwF;AACxF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAI9D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CA2Bd;AAED,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAS7C;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,UAAU,EAAE,CAM5E;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAKpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAqCN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,IAAI,CA4B1D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAgCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}
+{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAGjB,cAAc,EACd,iBAAiB,EAGjB,eAAe,EAChB,MAAM,8BAA8B,CAAC;AAStC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAgCvD;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAqBnC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;GAMG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CA4BV;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,iBAAiB,GAAE,iBAAsB,GACxC,UAAU,EAAE,CAMd;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,wFAAwF;AACxF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAI9D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CA2Bd;AAED,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAS7C;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,UAAU,EAAE,CAM5E;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAKpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAqCN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,IAAI,CA4B1D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAgCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}

package/dist/functions/gridEntities.lua

@@ -370,14 +370,14 @@ end
 -- For example:
 -- 
 -- ```ts
--- removeAllGridEntitiesExceptFor(
+-- removeAllGridEntitiesExcept(
 --   GridEntityType.WALL,
 --   GridEntityType.DOOR,
 -- );
 -- ```
 -- 
 -- @returns The grid entities that were removed.
-function ____exports.removeAllGridExcept(self, ...)
+function ____exports.removeAllGridEntitiesExcept(self, ...)
     local gridEntityTypes = {...}
     local gridEntityTypeExceptions = __TS__New(Set, gridEntityTypes)
     local gridEntities = ____exports.getGridEntities(nil)

package/dist/functions/npcs.lua

@@ -3,7 +3,7 @@ local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
-local NON_ALIVE_NPCS_TYPE_VARIANT, NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE
+local NON_ALIVE_NPCS_TYPE_VARIANT, NON_ALIVE_NPCS_TYPE_VARIANT_SUB_TYPE
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local BegottenVariant = ____isaac_2Dtypescript_2Ddefinitions.BegottenVariant
 local BigHornVariant = ____isaac_2Dtypescript_2Ddefinitions.BigHornVariant
@@ -34,7 +34,7 @@ function ____exports.isAliveExceptionNPC(self, npc)
         return true
     end
     local entityTypeVariantSubType = (((tostring(npc.Type) .. ".") .. tostring(npc.Variant)) .. ".") .. tostring(npc.SubType)
-    if NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE:has(entityTypeVariantSubType) then
+    if NON_ALIVE_NPCS_TYPE_VARIANT_SUB_TYPE:has(entityTypeVariantSubType) then
         return true
     end
     if ____exports.isDyingEggyWithNoSpidersLeft(nil, npc) then
@@ -86,7 +86,7 @@ NON_ALIVE_NPCS_TYPE_VARIANT = __TS__New(
         (tostring(EntityType.DARK_ESAU) .. ".") .. tostring(DarkEsauVariant.PIT)
     }
 )
-NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE = __TS__New(
+NON_ALIVE_NPCS_TYPE_VARIANT_SUB_TYPE = __TS__New(
     Set,
     {
         (((tostring(EntityType.CHARGER) .. ".") .. tostring(ChargerVariant.CHARGER)) .. ".") .. tostring(ChargerSubType.MY_SHADOW),

package/dist/functions/pickups.lua

@@ -2,7 +2,7 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____coinSubTypeToValue = require("objects.coinSubTypeToValue")
-local COIN_SUBTYPE_TO_VALUE = ____coinSubTypeToValue.COIN_SUBTYPE_TO_VALUE
+local COIN_SUB_TYPE_TO_VALUE = ____coinSubTypeToValue.COIN_SUB_TYPE_TO_VALUE
 local DEFAULT_COIN_VALUE = ____coinSubTypeToValue.DEFAULT_COIN_VALUE
 local ____chestPickupVariantsSet = require("sets.chestPickupVariantsSet")
 local CHEST_PICKUP_VARIANTS = ____chestPickupVariantsSet.CHEST_PICKUP_VARIANTS
@@ -17,7 +17,7 @@ local isHeart = ____pickupVariants.isHeart
 --- Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
 -- sub-types.
 function ____exports.getCoinValue(self, coinSubType)
-    local value = COIN_SUBTYPE_TO_VALUE[coinSubType]
+    local value = COIN_SUB_TYPE_TO_VALUE[coinSubType]
     return value == nil and DEFAULT_COIN_VALUE or value
 end
 --- Helper function to get all of the red heart pickup entities in the room.

package/dist/functions/trinketSet.d.ts

@@ -0,0 +1,44 @@
+import { TrinketType } from "isaac-typescript-definitions";
+/**
+ * Returns an array containing every valid trinket type in the game, including modded trinkets.
+ *
+ * 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.
+ */
+export declare function getModdedTrinketArray(): readonly TrinketType[];
+/**
+ * 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.
+ */
+export declare function getModdedTrinketSet(): ReadonlySet<TrinketType>;
+/**
+ * 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.
+ */
+export declare function getTrinketArray(): readonly TrinketType[];
+/**
+ * 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.
+ */
+export declare function getTrinketSet(): ReadonlySet<TrinketType>;
+/**
+ * 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.
+ */
+export declare function getVanillaTrinketArray(): readonly TrinketType[];
+/**
+ * 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.
+ */
+export declare function getVanillaTrinketSet(): ReadonlySet<TrinketType>;
+//# sourceMappingURL=trinketSet.d.ts.map

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

@@ -0,0 +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"}

package/dist/functions/trinketSet.lua

@@ -0,0 +1,101 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArraySort = ____lualib.__TS__ArraySort
+local ____exports = {}
+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 ____utils = require("functions.utils")
+local irange = ____utils.irange
+local ALL_TRINKETS_ARRAY = {}
+local VANILLA_TRINKETS_ARRAY = {}
+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)
+    if #ALL_TRINKETS_ARRAY ~= 0 then
+        return
+    end
+    local trinketTypeRange = irange(nil, FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE)
+    for ____, trinketType in ipairs(trinketTypeRange) do
+        do
+            local itemConfigItem = itemConfig:GetTrinket(trinketType)
+            if itemConfigItem == nil then
+                goto __continue4
+            end
+            ALL_TRINKETS_ARRAY[#ALL_TRINKETS_ARRAY + 1] = trinketType
+            if trinketType <= LAST_VANILLA_TRINKET_TYPE then
+                VANILLA_TRINKETS_ARRAY[#VANILLA_TRINKETS_ARRAY + 1] = trinketType
+            else
+                MODDED_TRINKETS_ARRAY[#MODDED_TRINKETS_ARRAY + 1] = trinketType
+            end
+        end
+        ::__continue4::
+    end
+    __TS__ArraySort(ALL_TRINKETS_ARRAY)
+    for ____, trinketType in ipairs(ALL_TRINKETS_ARRAY) do
+        ALL_TRINKETS_SET:add(trinketType)
+    end
+    __TS__ArraySort(VANILLA_TRINKETS_ARRAY)
+    for ____, trinketType in ipairs(VANILLA_TRINKETS_ARRAY) do
+        VANILLA_TRINKETS_SET:add(trinketType)
+    end
+    __TS__ArraySort(MODDED_TRINKETS_ARRAY)
+    for ____, trinketType in ipairs(MODDED_TRINKETS_ARRAY) do
+        MODDED_TRINKETS_SET:add(trinketType)
+    end
+end
+--- Returns an array containing every valid trinket type in the game, including modded trinkets.
+-- 
+-- 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.
+function ____exports.getModdedTrinketArray(self)
+    initTrinketArraysAndSets(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.
+function ____exports.getModdedTrinketSet(self)
+    initTrinketArraysAndSets(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.
+function ____exports.getTrinketArray(self)
+    initTrinketArraysAndSets(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.
+function ____exports.getTrinketSet(self)
+    initTrinketArraysAndSets(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.
+function ____exports.getVanillaTrinketArray(self)
+    initTrinketArraysAndSets(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.
+function ____exports.getVanillaTrinketSet(self)
+    initTrinketArraysAndSets(nil)
+    return VANILLA_TRINKETS_SET
+end
+return ____exports

package/dist/index.d.ts

@@ -140,6 +140,7 @@ export * from "./functions/transformations";
 export * from "./functions/trinketCacheFlag";
 export * from "./functions/trinketGive";
 export * from "./functions/trinkets";
+export * from "./functions/trinketSet";
 export * from "./functions/tstlClass";
 export * from "./functions/types";
 export * from "./functions/ui";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAClC,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,+BAA+B,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EACL,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,2BAA2B,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,cAAc,oCAAoC,CAAC;AACnD,OAAO,EACL,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAClC,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACL,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,+BAA+B,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EACL,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,2BAA2B,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,cAAc,oCAAoC,CAAC;AACnD,OAAO,EACL,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC"}

package/dist/index.lua

@@ -1111,6 +1111,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.trinketSet")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.tstlClass")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/initFeatures.lua

@@ -65,7 +65,7 @@ function initFeaturesMajor(self, mod)
     customGridEntityInit(nil, mod)
 end
 function initFeaturesMinor(self, mod)
-    customPickupInit(nil)
+    customPickupInit(nil, mod)
     customTrapdoorInit(nil, mod)
     disableAllSoundInit(nil, mod)
     disableInputsInit(nil, mod)

package/dist/objects/coinSubTypeToValue.d.ts

@@ -1,6 +1,6 @@
 import { CoinSubType } from "isaac-typescript-definitions";
 export declare const DEFAULT_COIN_VALUE = 1;
-export declare const COIN_SUBTYPE_TO_VALUE: {
+export declare const COIN_SUB_TYPE_TO_VALUE: {
     readonly [key in CoinSubType]: int;
 };
 //# sourceMappingURL=coinSubTypeToValue.d.ts.map

package/dist/objects/coinSubTypeToValue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coinSubTypeToValue.d.ts","sourceRoot":"","sources":["../../src/objects/coinSubTypeToValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC,eAAO,MAAM,qBAAqB,EAAE;IAAE,QAAQ,EAAE,GAAG,IAAI,WAAW,GAAG,GAAG;CAS9D,CAAC"}
+{"version":3,"file":"coinSubTypeToValue.d.ts","sourceRoot":"","sources":["../../src/objects/coinSubTypeToValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,eAAO,MAAM,kBAAkB,IAAI,CAAC;AAEpC,eAAO,MAAM,sBAAsB,EAAE;IAAE,QAAQ,EAAE,GAAG,IAAI,WAAW,GAAG,GAAG;CAS/D,CAAC"}

package/dist/objects/coinSubTypeToValue.lua

@@ -2,7 +2,7 @@ local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CoinSubType = ____isaac_2Dtypescript_2Ddefinitions.CoinSubType
 ____exports.DEFAULT_COIN_VALUE = 1
-____exports.COIN_SUBTYPE_TO_VALUE = {
+____exports.COIN_SUB_TYPE_TO_VALUE = {
     [CoinSubType.NULL] = 0,
     [CoinSubType.PENNY] = 1,
     [CoinSubType.NICKEL] = 5,

package/package.json

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

package/src/features/customPickup.ts

@@ -1,9 +1,135 @@
+import {
+  EffectVariant,
+  EntityType,
+  ModCallback,
+  PickupVariant,
+} from "isaac-typescript-definitions";
 import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
+import {
+  getEntityID,
+  getEntityIDFromConstituents,
+} from "../functions/entities";
+import { spawnEffect } from "../functions/entitiesSpecific";
 
 const FEATURE_NAME = "customPickup";
 
-export function customPickupInit(): void {}
+interface CustomPickupFunctions {
+  collectFunc: (player: EntityPlayer) => void;
+  collisionFunc: (player: EntityPlayer) => boolean;
+}
+
+/**
+ * Normally, we would make a custom entity to represent a fading-away pickup, but we don't want to
+ * interfere with the "entities2.xml" file in end-user mods. Thus, we must select a vanilla effect
+ * to masquerade as a backdrop effect.
+ *
+ * We arbitrarily choose a ladder for this purpose because it will not automatically despawn after
+ * time passes, like most other effects.
+ */
+const PICKUP_EFFECT_VARIANT = EffectVariant.LADDER;
+const PICKUP_EFFECT_SUB_TYPE = 103;
+
+/** Indexed by entity ID. */
+const customPickupFunctionsMap = new Map<string, CustomPickupFunctions>();
+
+export function customPickupInit(mod: Mod): void {
+  mod.AddCallback(ModCallback.PRE_PICKUP_COLLISION, prePickupCollision); // 38
+  mod.AddCallback(
+    ModCallback.POST_EFFECT_RENDER,
+    postEffectRenderPickupEffect,
+    PICKUP_EFFECT_VARIANT,
+  ); // 56
+}
+
+// ModCallback.PRE_PICKUP_COLLISION (38)
+function prePickupCollision(
+  pickup: EntityPickup,
+  collider: Entity,
+): boolean | undefined {
+  const entityID = getEntityID(pickup);
+  const customPickupFunctions = customPickupFunctionsMap.get(entityID);
+  if (customPickupFunctions === undefined) {
+    return undefined;
+  }
+
+  const player = collider.ToPlayer();
+  if (player === undefined) {
+    return undefined;
+  }
+
+  const shouldPickup = customPickupFunctions.collisionFunc(player);
+  if (!shouldPickup) {
+    return undefined;
+  }
+
+  pickup.Remove();
 
-export function registerCustomPickup(): void {
+  const pickupSprite = pickup.GetSprite();
+  const fileName = pickupSprite.GetFilename();
+
+  const effect = spawnEffect(
+    PICKUP_EFFECT_VARIANT,
+    PICKUP_EFFECT_SUB_TYPE,
+    pickup.Position,
+  );
+  const effectSprite = effect.GetSprite();
+  effectSprite.Load(fileName, true);
+  effectSprite.Play("Collect", true);
+
+  customPickupFunctions.collectFunc(player);
+
+  return undefined;
+}
+
+// ModCallback.POST_EFFECT_RENDER (56)
+// PICKUP_EFFECT_VARIANT
+function postEffectRenderPickupEffect(effect: EntityEffect) {
+  if (effect.SubType !== PICKUP_EFFECT_SUB_TYPE) {
+    return;
+  }
+
+  const sprite = effect.GetSprite();
+  if (sprite.IsFinished("Collect")) {
+    effect.Remove();
+  }
+}
+
+/**
+ * Helper function to register a custom pickup with the IsaacScript standard library. Use this
+ * feature for custom pickups that are intended to be picked up by the player, like keys and bombs.
+ *
+ * When IsaacScript detects that a player should be collecting the custom pickup, then the pickup
+ * will be immediately removed, and an effect showing the pickup's respective `Collect` animation
+ * will be spawned. (This emulates how a normal vanilla pickup would work.)
+ *
+ * Note that when you specify your custom pickup in the "entities2.xml" file, it should have a type
+ * of "5" and be associated with an anm2 file that has a "Collect" animation.
+ *
+ * @param pickupVariantCustom The variant for the corresponding custom pickup.
+ * @param subType The sub-type for the corresponding custom pickup.
+ * @param collectFunc The function to run when the player collects this pickup.
+ * @param collisionFunc Optional. The function to run when a player collides with the pickup.
+ *                      Default is a function that always returns true, meaning that the player will
+ *                      always immediately collect the pickup when they collide with it. Specify
+ *                      this function if your pickup should only be able to be collected under
+ *                      certain conditions.
+ */
+export function registerCustomPickup(
+  pickupVariantCustom: PickupVariant,
+  subType: int,
+  collectFunc: (player: EntityPlayer) => void,
+  collisionFunc: (player: EntityPlayer) => boolean = () => true,
+): void {
   errorIfFeaturesNotInitialized(FEATURE_NAME);
+
+  const entityID = getEntityIDFromConstituents(
+    EntityType.PICKUP,
+    pickupVariantCustom,
+    subType,
+  );
+  const customPickupFunctions: CustomPickupFunctions = {
+    collectFunc,
+    collisionFunc,
+  };
+  customPickupFunctionsMap.set(entityID, customPickupFunctions);
 }

package/src/features/customStage/backdrop.ts

@@ -83,7 +83,7 @@ const N_FLOOR_ANM2_LAYERS: readonly int[] = [18, 19];
  * time passes, like most other effects.
  */
 const BACKDROP_EFFECT_VARIANT = EffectVariant.LADDER;
-const BACKDROP_EFFECT_SUBTYPE = 101;
+const BACKDROP_EFFECT_SUB_TYPE = 101;
 
 const BACKDROP_ROOM_TYPE_SET: ReadonlySet<RoomType> = new Set([
   RoomType.DEFAULT,
@@ -135,7 +135,7 @@ function spawnWallEntity(
   const seed = 1 as Seed;
   const wallEffect = spawnEffectWithSeed(
     BACKDROP_EFFECT_VARIANT,
-    BACKDROP_EFFECT_SUBTYPE,
+    BACKDROP_EFFECT_SUB_TYPE,
     VectorZero,
     seed,
   );

package/src/features/customStage/shadows.ts

@@ -18,7 +18,7 @@ type ShadowAnimation = "1x1" | "1x2" | "2x1" | "2x2";
  * time passes, like most other effects.
  */
 const SHADOW_EFFECT_VARIANT = EffectVariant.LADDER;
-const SHADOW_EFFECT_SUBTYPE = 102;
+const SHADOW_EFFECT_SUB_TYPE = 102;
 
 /** The animation comes from StageAPI. */
 const ROOM_SHAPE_TO_SHADOW_ANIMATION: {
@@ -60,7 +60,7 @@ export function setShadows(customStage: CustomStage): void {
   const seed = 1 as Seed;
   const shadowEffect = spawnEffectWithSeed(
     SHADOW_EFFECT_VARIANT,
-    SHADOW_EFFECT_SUBTYPE,
+    SHADOW_EFFECT_SUB_TYPE,
     centerPos,
     seed,
   );

package/src/features/deployJSONRoom.ts

@@ -40,7 +40,7 @@ import {
   convertXMLGridEntityType,
   getAllGridIndexes,
   getGridEntities,
-  removeAllGridExcept,
+  removeAllGridEntitiesExcept,
   removeGridEntity,
   setGridEntityInvisible,
   spawnGridEntityWithVariant,
@@ -341,7 +341,7 @@ export function emptyRoom(fillWithDecorations: boolean): void {
   removeAllMatchingEntities(EntityType.EFFECT, EffectVariant.DEVIL);
   removeAllMatchingEntities(EntityType.EFFECT, EffectVariant.ANGEL);
 
-  removeAllGridExcept(
+  removeAllGridEntitiesExcept(
     GridEntityType.WALL, // 15
     GridEntityType.DOOR, // 16
   );

package/src/functions/collectibleSet.ts

@@ -39,15 +39,16 @@ function initCollectibleArraysAndSets() {
   }
 
   ALL_COLLECTIBLES_ARRAY.sort();
-  VANILLA_COLLECTIBLES_ARRAY.sort();
-  MODDED_COLLECTIBLES_ARRAY.sort();
-
   for (const collectibleType of ALL_COLLECTIBLES_ARRAY) {
     ALL_COLLECTIBLES_SET.add(collectibleType);
   }
+
+  VANILLA_COLLECTIBLES_ARRAY.sort();
   for (const collectibleType of VANILLA_COLLECTIBLES_ARRAY) {
     VANILLA_COLLECTIBLES_SET.add(collectibleType);
   }
+
+  MODDED_COLLECTIBLES_ARRAY.sort();
   for (const collectibleType of MODDED_COLLECTIBLES_ARRAY) {
     MODDED_COLLECTIBLES_SET.add(collectibleType);
   }

package/src/functions/gridEntities.ts

@@ -395,7 +395,7 @@ export function isPostBossVoidPortal(gridEntity: GridEntity): boolean {
  * For example:
  *
  * ```ts
- * removeAllGridEntitiesExceptFor(
+ * removeAllGridEntitiesExcept(
  *   GridEntityType.WALL,
  *   GridEntityType.DOOR,
  * );
@@ -403,7 +403,7 @@ export function isPostBossVoidPortal(gridEntity: GridEntity): boolean {
  *
  * @returns The grid entities that were removed.
  */
-export function removeAllGridExcept(
+export function removeAllGridEntitiesExcept(
   ...gridEntityTypes: GridEntityType[]
 ): GridEntity[] {
   const gridEntityTypeExceptions = new Set(gridEntityTypes);

package/src/functions/npcs.ts

@@ -41,7 +41,7 @@ const NON_ALIVE_NPCS_TYPE_VARIANT: ReadonlySet<string> = new Set([
  * Used to filter out certain NPCs when determining of an NPC is "alive" and/or should keep the
  * doors open.
  */
-const NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE: ReadonlySet<string> = new Set([
+const NON_ALIVE_NPCS_TYPE_VARIANT_SUB_TYPE: ReadonlySet<string> = new Set([
   `${EntityType.CHARGER}.${ChargerVariant.CHARGER}.${ChargerSubType.MY_SHADOW}`, // 23.0.1
   `${EntityType.MOTHER}.${MotherVariant.MOTHER_1}.${MotherSubType.PHASE_2}`, // 912
 ]);
@@ -81,7 +81,7 @@ export function isAliveExceptionNPC(npc: EntityNPC): boolean {
   }
 
   const entityTypeVariantSubType = `${npc.Type}.${npc.Variant}.${npc.SubType}`;
-  if (NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE.has(entityTypeVariantSubType)) {
+  if (NON_ALIVE_NPCS_TYPE_VARIANT_SUB_TYPE.has(entityTypeVariantSubType)) {
     return true;
   }
 

package/src/functions/pickups.ts

@@ -1,6 +1,6 @@
 import { CoinSubType } from "isaac-typescript-definitions";
 import {
-  COIN_SUBTYPE_TO_VALUE,
+  COIN_SUB_TYPE_TO_VALUE,
   DEFAULT_COIN_VALUE,
 } from "../objects/coinSubTypeToValue";
 import { CHEST_PICKUP_VARIANTS } from "../sets/chestPickupVariantsSet";
@@ -14,7 +14,7 @@ import { isHeart } from "./pickupVariants";
  * sub-types.
  */
 export function getCoinValue(coinSubType: CoinSubType): int {
-  const value = COIN_SUBTYPE_TO_VALUE[coinSubType];
+  const value = COIN_SUB_TYPE_TO_VALUE[coinSubType];
   // Handle modded coin sub-types.
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   return value === undefined ? DEFAULT_COIN_VALUE : value;

package/src/functions/trinketSet.ts

@@ -0,0 +1,133 @@
+import { TrinketType } from "isaac-typescript-definitions";
+import { itemConfig } from "../core/cachedClasses";
+import {
+  FIRST_TRINKET_TYPE,
+  LAST_TRINKET_TYPE,
+  LAST_VANILLA_TRINKET_TYPE,
+} from "../core/constantsFirstLast";
+import { irange } from "./utils";
+
+const ALL_TRINKETS_ARRAY: TrinketType[] = [];
+const VANILLA_TRINKETS_ARRAY: TrinketType[] = [];
+const MODDED_TRINKETS_ARRAY: TrinketType[] = [];
+
+const ALL_TRINKETS_SET = new Set<TrinketType>();
+const VANILLA_TRINKETS_SET = new Set<TrinketType>();
+const MODDED_TRINKETS_SET = new Set<TrinketType>();
+
+function initTrinketArraysAndSets() {
+  if (ALL_TRINKETS_ARRAY.length !== 0) {
+    return;
+  }
+
+  const trinketTypeRange = irange(
+    FIRST_TRINKET_TYPE,
+    LAST_TRINKET_TYPE,
+  ) as TrinketType[];
+  for (const trinketType of trinketTypeRange) {
+    const itemConfigItem = itemConfig.GetTrinket(trinketType);
+    if (itemConfigItem === undefined) {
+      continue;
+    }
+
+    ALL_TRINKETS_ARRAY.push(trinketType);
+    if (trinketType <= LAST_VANILLA_TRINKET_TYPE) {
+      VANILLA_TRINKETS_ARRAY.push(trinketType);
+    } else {
+      MODDED_TRINKETS_ARRAY.push(trinketType);
+    }
+  }
+
+  ALL_TRINKETS_ARRAY.sort();
+  for (const trinketType of ALL_TRINKETS_ARRAY) {
+    ALL_TRINKETS_SET.add(trinketType);
+  }
+
+  VANILLA_TRINKETS_ARRAY.sort();
+  for (const trinketType of VANILLA_TRINKETS_ARRAY) {
+    VANILLA_TRINKETS_SET.add(trinketType);
+  }
+
+  MODDED_TRINKETS_ARRAY.sort();
+  for (const trinketType of MODDED_TRINKETS_ARRAY) {
+    MODDED_TRINKETS_SET.add(trinketType);
+  }
+}
+
+/**
+ * Returns an array containing every valid trinket type in the game, including modded trinkets.
+ *
+ * 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.
+ */
+export function getModdedTrinketArray(): readonly TrinketType[] {
+  // Lazy initialize the arrays/sets.
+  initTrinketArraysAndSets();
+
+  return MODDED_TRINKETS_ARRAY;
+}
+
+/**
+ * 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.
+ */
+export function getModdedTrinketSet(): ReadonlySet<TrinketType> {
+  // Lazy initialize the arrays/sets.
+  initTrinketArraysAndSets();
+
+  return MODDED_TRINKETS_SET;
+}
+
+/**
+ * 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.
+ */
+export function getTrinketArray(): readonly TrinketType[] {
+  // Lazy initialize the arrays/sets.
+  initTrinketArraysAndSets();
+
+  return ALL_TRINKETS_ARRAY;
+}
+
+/**
+ * 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.
+ */
+export function getTrinketSet(): ReadonlySet<TrinketType> {
+  // Lazy initialize the arrays/sets.
+  initTrinketArraysAndSets();
+
+  return ALL_TRINKETS_SET;
+}
+
+/**
+ * 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.
+ */
+export function getVanillaTrinketArray(): readonly TrinketType[] {
+  // Lazy initialize the arrays/sets.
+  initTrinketArraysAndSets();
+
+  return VANILLA_TRINKETS_ARRAY;
+}
+
+/**
+ * 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.
+ */
+export function getVanillaTrinketSet(): ReadonlySet<TrinketType> {
+  // Lazy initialize the arrays/sets.
+  initTrinketArraysAndSets();
+
+  return VANILLA_TRINKETS_SET;
+}

package/src/index.ts

@@ -176,6 +176,7 @@ export * from "./functions/transformations";
 export * from "./functions/trinketCacheFlag";
 export * from "./functions/trinketGive";
 export * from "./functions/trinkets";
+export * from "./functions/trinketSet";
 export * from "./functions/tstlClass";
 export * from "./functions/types";
 export * from "./functions/ui";

package/src/initFeatures.ts

@@ -43,7 +43,7 @@ function initFeaturesMajor(mod: ModUpgraded) {
 }
 
 function initFeaturesMinor(mod: ModUpgraded) {
-  customPickupInit();
+  customPickupInit(mod);
   customTrapdoorInit(mod);
   disableAllSoundInit(mod);
   disableInputsInit(mod);

package/src/objects/coinSubTypeToValue.ts

@@ -2,7 +2,7 @@ import { CoinSubType } from "isaac-typescript-definitions";
 
 export const DEFAULT_COIN_VALUE = 1;
 
-export const COIN_SUBTYPE_TO_VALUE: { readonly [key in CoinSubType]: int } = {
+export const COIN_SUB_TYPE_TO_VALUE: { readonly [key in CoinSubType]: int } = {
   [CoinSubType.NULL]: 0, // 0
   [CoinSubType.PENNY]: 1, // 1
   [CoinSubType.NICKEL]: 5, // 2