isaacscript-common 2.0.29 → 2.0.32

package/dist/enums/private/SaveDataKey.d.ts

@@ -0,0 +1,7 @@
+export declare enum SaveDataKey {
+    PERSISTENT = "persistent",
+    RUN = "run",
+    LEVEL = "level",
+    ROOM = "room"
+}
+export declare const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey>;

package/dist/enums/private/SaveDataKey.lua

@@ -0,0 +1,11 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+____exports.SaveDataKey = {}
+____exports.SaveDataKey.PERSISTENT = "persistent"
+____exports.SaveDataKey.RUN = "run"
+____exports.SaveDataKey.LEVEL = "level"
+____exports.SaveDataKey.ROOM = "room"
+____exports.RESETTABLE_SAVE_DATA_KEYS = __TS__New(Set, {____exports.SaveDataKey.RUN, ____exports.SaveDataKey.LEVEL, ____exports.SaveDataKey.ROOM})
+return ____exports

package/dist/features/saveDataManager/exports.d.ts

@@ -105,3 +105,24 @@ export declare function saveDataManagerSave(): void;
  * e.g. `l print(g.feature1.foo)`
  */
 export declare function saveDataManagerSetGlobal(): void;
+/**
+ * The save data manager will automatically reset variables at the appropriate times (i.e. when a
+ * player enters a new room). Use this function to explicitly force the save data manager to reset a
+ * specific variable group.
+ *
+ * For example:
+ *
+ * ```
+ * const v = {
+ *   room: {
+ *     foo: 123,
+ *   },
+ * };
+ *
+ * saveDataManager("file1", v);
+ *
+ * // Then, later on, to explicit reset all of the "room" variables:
+ * saveDataManagerReset("file1", "room");
+ * ```
+ */
+export declare function saveDataManagerReset(key: string, childObjectKey: string): void;

package/dist/features/saveDataManager/exports.lua

@@ -13,6 +13,7 @@ local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_N
 local ____main = require("features.saveDataManager.main")
 local forceSaveDataManagerLoad = ____main.forceSaveDataManagerLoad
 local forceSaveDataManagerSave = ____main.forceSaveDataManagerSave
+local restoreDefaultSaveData = ____main.restoreDefaultSaveData
 local ____maps = require("features.saveDataManager.maps")
 local saveDataConditionalFuncMap = ____maps.saveDataConditionalFuncMap
 local saveDataDefaultsMap = ____maps.saveDataDefaultsMap
@@ -50,4 +51,16 @@ function ____exports.saveDataManagerSetGlobal(self)
     g = saveDataMap
     gd = saveDataDefaultsMap
 end
+function ____exports.saveDataManagerReset(self, key, childObjectKey)
+    errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
+    local keyType = type(key)
+    if keyType ~= "string" then
+        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " requires that keys are strings. You tried to use a key of type: ") .. keyType)
+    end
+    local saveData = saveDataMap[key]
+    if saveData == nil then
+        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " is not managing save data for a key of: ") .. key)
+    end
+    restoreDefaultSaveData(nil, key, saveData, childObjectKey)
+end
 return ____exports

package/dist/features/saveDataManager/main.d.ts

@@ -1 +1,3 @@
-export {};
+import { SaveDataKey } from "../../enums/private/SaveDataKey";
+import { SaveData } from "../../types/private/SaveData";
+export declare function restoreDefaultSaveData(subscriberName: string, saveData: SaveData, saveDataKey: SaveDataKey): void;

package/dist/features/saveDataManager/main.lua

@@ -8,8 +8,9 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
-local ____SaveDataKeys = require("enums.private.SaveDataKeys")
-local SaveDataKeys = ____SaveDataKeys.SaveDataKeys
+local ____SaveDataKey = require("enums.private.SaveDataKey")
+local RESETTABLE_SAVE_DATA_KEYS = ____SaveDataKey.RESETTABLE_SAVE_DATA_KEYS
+local SaveDataKey = ____SaveDataKey.SaveDataKey
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
 local ____deepCopy = require("functions.deepCopy")
@@ -52,41 +53,41 @@ function preGameExit(self)
     loadedDataOnThisRun = false
 end
 function postNewLevel(self)
-    restoreDefaults(nil, SaveDataKeys.LEVEL)
+    restoreDefaults(nil, SaveDataKey.LEVEL)
 end
 function postNewRoomEarly(self)
-    restoreDefaults(nil, SaveDataKeys.ROOM)
+    restoreDefaults(nil, SaveDataKey.ROOM)
 end
 function restoreDefaultsAll(self)
-    restoreDefaults(nil, SaveDataKeys.RUN)
-    restoreDefaults(nil, SaveDataKeys.LEVEL)
-    restoreDefaults(nil, SaveDataKeys.ROOM)
+    restoreDefaults(nil, SaveDataKey.RUN)
+    restoreDefaults(nil, SaveDataKey.LEVEL)
+    restoreDefaults(nil, SaveDataKey.ROOM)
 end
-function restoreDefaults(self, childTableName)
-    if childTableName ~= SaveDataKeys.RUN and childTableName ~= SaveDataKeys.LEVEL and childTableName ~= SaveDataKeys.ROOM then
-        error("Unknown child table name of: " .. childTableName)
-    end
+function restoreDefaults(self, saveDataKey)
     for subscriberName, saveData in pairs(saveDataMap) do
-        do
-            local childTable = saveData[childTableName]
-            if childTable == nil then
-                goto __continue14
-            end
-            local saveDataDefaults = saveDataDefaultsMap[subscriberName]
-            if saveDataDefaults == nil then
-                logError("Failed to find the default copy of the save data for subscriber: " .. subscriberName)
-                goto __continue14
-            end
-            local childTableDefaults = saveDataDefaults[childTableName]
-            if childTableDefaults == nil then
-                logError(((("Failed to find the default copy of the child table \"" .. childTableName) .. "\" for subscriber \"") .. subscriberName) .. "\". This error usually means that your save data is out of date. You can try purging all of your save data by deleting the following directory: C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\data")
-                goto __continue14
-            end
-            local childTableDefaultsCopy = deepCopy(nil, childTableDefaults, SerializationType.NONE, (subscriberName .. " --> ") .. childTableName)
-            clearAndCopyAllElements(nil, childTable, childTableDefaultsCopy)
-        end
-        ::__continue14::
+        ____exports.restoreDefaultSaveData(nil, subscriberName, saveData, saveDataKey)
+    end
+end
+function ____exports.restoreDefaultSaveData(self, subscriberName, saveData, saveDataKey)
+    if not RESETTABLE_SAVE_DATA_KEYS:has(saveDataKey) then
+        error("Unknown save data key name of: " .. saveDataKey)
+    end
+    local childTable = saveData[saveDataKey]
+    if childTable == nil then
+        return
+    end
+    local saveDataDefaults = saveDataDefaultsMap[subscriberName]
+    if saveDataDefaults == nil then
+        logError("Failed to find the default copy of the save data for subscriber: " .. subscriberName)
+        return
+    end
+    local childTableDefaults = saveDataDefaults[saveDataKey]
+    if childTableDefaults == nil then
+        logError(((("Failed to find the default copy of the child table \"" .. saveDataKey) .. "\" for subscriber \"") .. subscriberName) .. "\". This error usually means that your save data is out of date. You can try purging all of your save data by deleting the following directory: C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\data")
+        return
     end
+    local childTableDefaultsCopy = deepCopy(nil, childTableDefaults, SerializationType.NONE, (subscriberName .. " --> ") .. saveDataKey)
+    clearAndCopyAllElements(nil, childTable, childTableDefaultsCopy)
 end
 function clearAndCopyAllElements(self, oldTable, newTable)
     clearTable(nil, oldTable)

package/dist/functions/collectibleSet.lua

@@ -15,8 +15,11 @@ local VANILLA_COLLECTIBLES_SET = __TS__New(Set)
 local MODDED_COLLECTIBLES_SET = __TS__New(Set)
 local function initCollectibleSets(self)
     for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
-        local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-        if itemConfigItem ~= nil then
+        do
+            local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+            if itemConfigItem == nil then
+                goto __continue3
+            end
             ALL_COLLECTIBLES_SET:add(collectibleType)
             if collectibleType <= LAST_VANILLA_COLLECTIBLE_TYPE then
                 VANILLA_COLLECTIBLES_SET:add(collectibleType)
@@ -24,6 +27,7 @@ local function initCollectibleSets(self)
                 MODDED_COLLECTIBLES_SET:add(collectibleType)
             end
         end
+        ::__continue3::
     end
 end
 function ____exports.getCollectibleSet(self)

package/dist/functions/collectibles.d.ts

@@ -142,6 +142,12 @@ export declare function isBlindCollectible(collectible: EntityPickup): boolean;
  * in secret rooms and I AM ERROR rooms if the "Corrupted Data" achievement is unlocked.
  */
 export declare function isGlitchedCollectible(pickup: EntityPickup): boolean;
+/**
+ * Returns true if the collectible has the "Hidden" attribute in the item config.
+ *
+ * Hidden collectibles will not show up in any pools and Eden will not start with them.
+ */
+export declare function isHiddenCollectible(collectibleType: CollectibleType): boolean;
 /**
  * Returns true if the item type in the item config is equal to `ItemType.ITEM_PASSIVE` or
  * `ItemType.ITEM_FAMILIAR`.

package/dist/functions/collectibles.lua

@@ -216,6 +216,10 @@ end
 function ____exports.isGlitchedCollectible(self, pickup)
     return pickup.Variant == PickupVariant.COLLECTIBLE and pickup.SubType > GLITCHED_ITEM_THRESHOLD
 end
+function ____exports.isHiddenCollectible(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    return itemConfigItem ~= nil and itemConfigItem.Hidden
+end
 function ____exports.isPassiveCollectible(self, collectibleType)
     local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
     return itemType == ItemType.PASSIVE or itemType == ItemType.FAMILIAR

package/dist/functions/eden.d.ts

@@ -0,0 +1,3 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+export declare function getEdenPassives(): Set<CollectibleType>;
+export declare function getRandomEdenPassive(seedOrRNG?: Seed | RNG, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;

package/dist/functions/eden.lua

@@ -0,0 +1,47 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
+local ____collectibles = require("functions.collectibles")
+local isHiddenCollectible = ____collectibles.isHiddenCollectible
+local isPassiveCollectible = ____collectibles.isPassiveCollectible
+local ____collectibleSet = require("functions.collectibleSet")
+local getCollectibleSet = ____collectibleSet.getCollectibleSet
+local ____collectibleTag = require("functions.collectibleTag")
+local collectibleHasTag = ____collectibleTag.collectibleHasTag
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local ____set = require("functions.set")
+local copySet = ____set.copySet
+local getRandomSetElement = ____set.getRandomSetElement
+local EDEN_PASSIVE_COLLECTIBLES_SET = __TS__New(Set)
+local function initCollectibleSet(self)
+    local collectibleSet = getCollectibleSet(nil)
+    for ____, collectibleType in __TS__Iterator(collectibleSet:values()) do
+        if isPassiveCollectible(nil, collectibleType) and not isHiddenCollectible(nil, collectibleType) and not collectibleHasTag(nil, collectibleType, ItemConfigTag.NO_EDEN) then
+            EDEN_PASSIVE_COLLECTIBLES_SET:add(collectibleType)
+        end
+    end
+end
+function ____exports.getEdenPassives(self)
+    if EDEN_PASSIVE_COLLECTIBLES_SET.size == 0 then
+        initCollectibleSet(nil)
+    end
+    return copySet(nil, EDEN_PASSIVE_COLLECTIBLES_SET)
+end
+function ____exports.getRandomEdenPassive(self, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    if EDEN_PASSIVE_COLLECTIBLES_SET.size == 0 then
+        initCollectibleSet(nil)
+    end
+    return getRandomSetElement(nil, EDEN_PASSIVE_COLLECTIBLES_SET, seedOrRNG, exceptions)
+end
+return ____exports

package/dist/functions/pills.lua

@@ -25,11 +25,8 @@ local DEFAULT_PILL_EFFECT_TYPE = ____pillEffectTypes.DEFAULT_PILL_EFFECT_TYPE
 local PILL_EFFECT_TYPES = ____pillEffectTypes.PILL_EFFECT_TYPES
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
-local ____flag = require("functions.flag")
-local hasFlag = ____flag.hasFlag
 local ____utils = require("functions.utils")
 local irange = ____utils.irange
-local HORSE_PILL_FLAG = 2047
 local HORSE_PILL_ADJUSTMENT = 2048
 function ____exports.getAllPillColors(self)
     local pillColors = getEnumValues(nil, PillColor)
@@ -81,6 +78,6 @@ function ____exports.getVanillaPillEffects(self)
     return irange(nil, FIRST_PILL_EFFECT, LAST_VANILLA_PILL_EFFECT)
 end
 function ____exports.isHorsePill(self, pillColor)
-    return hasFlag(nil, pillColor, HORSE_PILL_FLAG)
+    return pillColor > HORSE_PILL_ADJUSTMENT
 end
 return ____exports

package/dist/functions/trinkets.lua

@@ -28,7 +28,6 @@ local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
 local ____utils = require("functions.utils")
 local irange = ____utils.irange
-local GOLDEN_TRINKET_FLAG = 32767
 local GOLDEN_TRINKET_ADJUSTMENT = 32768
 local TRINKET_SPRITE_LAYER = 0
 function ____exports.getGoldenTrinketType(self, trinketType)
@@ -91,7 +90,7 @@ function ____exports.hasOpenTrinketSlot(self, player)
     return openTrinketSlot ~= nil
 end
 function ____exports.isGoldenTrinket(self, trinketType)
-    return hasFlag(nil, trinketType, GOLDEN_TRINKET_FLAG)
+    return trinketType > GOLDEN_TRINKET_ADJUSTMENT
 end
 function ____exports.setTrinketSprite(self, trinket, pngPath)
     if not isTrinket(nil, trinket) then

package/dist/index.d.ts

@@ -48,6 +48,7 @@ export { deepCopyTests } from "./functions/deepCopyTests";
 export * from "./functions/direction";
 export * from "./functions/doors";
 export * from "./functions/easing";
+export * from "./functions/eden";
 export * from "./functions/entity";
 export * from "./functions/entitySpecific";
 export * from "./functions/entityTypes";

package/dist/index.lua

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "2.0.29",
+  "version": "2.0.32",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.46"
+    "isaac-typescript-definitions": "^2.0.48"
   },
   "devDependencies": {
     "isaacscript-lint": "^1.0.159",