isaacscript-common 3.1.1 → 3.2.0

package/classes/DefaultMap.d.ts

@@ -46,7 +46,7 @@ export declare type FactoryFunction<V, Args extends unknown[]> = (...extraArgs:
  *
  * ```ts
  * // Initializes a new empty DefaultMap with a default value of a new empty array.
- * const factoryFunction = () => [] as ;
+ * const factoryFunction = () => [];
  * const defaultMapWithArray = new DefaultMap<string, string[]>(factoryFunction);
  * ```
  *
@@ -96,7 +96,6 @@ export declare class DefaultMap<Key, Value, Args extends unknown[] = []> extends
      * it will set a default value for the provided key, and then return the default value.
      */
     getAndSetDefault(key: Key, ...extraArgs: Args): Value;
-    getWithoutDefault(key: Key): Value | undefined;
     /**
      * Returns the default value to be used for a new key. (If a factory function was provided during
      * instantiation, this will execute the factory function.)

package/classes/DefaultMap.lua

@@ -46,7 +46,7 @@ local ____exports = {}
 -- 
 -- ```ts
 -- // Initializes a new empty DefaultMap with a default value of a new empty array.
--- const factoryFunction = () => [] as ;
+-- const factoryFunction = () => [];
 -- const defaultMapWithArray = new DefaultMap<string, string[]>(factoryFunction);
 -- ```
 -- 
@@ -111,9 +111,6 @@ function DefaultMap.prototype.getAndSetDefault(self, key, ...)
     self:set(key, defaultValue)
     return defaultValue
 end
-function DefaultMap.prototype.getWithoutDefault(self, key)
-    return Map.prototype.get(self, key)
-end
 function DefaultMap.prototype.getDefaultValue(self, ...)
     if self.defaultValue ~= nil then
         return self.defaultValue

package/functions/saveFile.d.ts

@@ -0,0 +1,15 @@
+import { CollectibleType, ItemPoolType } from "isaac-typescript-definitions";
+/**
+ * Helper function to see if the given collectible is unlocked on the player's save file. This
+ * requires providing the corresponding item pool that the collectible is located in.
+ *
+ * - If any player currently has the item, then it is assumed to be unlocked. (This is because Eden
+ *   may have randomly started with the provided collectible, and it will be subsequently removed
+ *   from all pools.)
+ * - If the collectible is located in more than one item pool, then any item pool can be provided.
+ * - If the collectible is not located in any item pools, then this function will always return
+ *   false.
+ * - If any player is Tainted Lost, they will be temporarily changed to Isaac and then temporarily
+ *   changed back (because Tainted Lost is not able to retrieve some collectibles from item pools).
+ */
+export declare function isCollectibleUnlocked(collectibleTypeToCheckFor: CollectibleType, itemPoolToCheckFor: ItemPoolType): boolean;

package/functions/saveFile.lua

@@ -0,0 +1,106 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____collectibleSet = require("functions.collectibleSet")
+local getCollectibleSet = ____collectibleSet.getCollectibleSet
+local ____player = require("functions.player")
+local anyPlayerHasCollectible = ____player.anyPlayerHasCollectible
+local getPlayersOfType = ____player.getPlayersOfType
+local ____playerDataStructures = require("functions.playerDataStructures")
+local mapGetPlayer = ____playerDataStructures.mapGetPlayer
+local mapSetPlayer = ____playerDataStructures.mapSetPlayer
+local ____playerIndex = require("functions.playerIndex")
+local getPlayers = ____playerIndex.getPlayers
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
+local COLLECTIBLES_THAT_AFFECT_ITEM_POOLS = {CollectibleType.CHAOS, CollectibleType.SACRED_ORB, CollectibleType.TMTRAINER}
+local TRINKETS_THAT_AFFECT_ITEM_POOLS = {TrinketType.NO}
+--- Helper function to see if the given collectible is unlocked on the player's save file. This
+-- requires providing the corresponding item pool that the collectible is located in.
+-- 
+-- - If any player currently has the item, then it is assumed to be unlocked. (This is because Eden
+--   may have randomly started with the provided collectible, and it will be subsequently removed
+--   from all pools.)
+-- - If the collectible is located in more than one item pool, then any item pool can be provided.
+-- - If the collectible is not located in any item pools, then this function will always return
+--   false.
+-- - If any player is Tainted Lost, they will be temporarily changed to Isaac and then temporarily
+--   changed back (because Tainted Lost is not able to retrieve some collectibles from item pools).
+function ____exports.isCollectibleUnlocked(self, collectibleTypeToCheckFor, itemPoolToCheckFor)
+    if anyPlayerHasCollectible(nil, collectibleTypeToCheckFor) then
+        return true
+    end
+    local taintedLosts = getPlayersOfType(nil, PlayerType.THE_LOST_B)
+    for ____, player in ipairs(taintedLosts) do
+        player:ChangePlayerType(PlayerType.ISAAC)
+    end
+    local removedItemsMap = __TS__New(Map)
+    local removedTrinketsMap = __TS__New(Map)
+    for ____, player in ipairs(getPlayers(nil)) do
+        local removedItems = {}
+        for ____, itemToRemove in ipairs(COLLECTIBLES_THAT_AFFECT_ITEM_POOLS) do
+            if player:HasCollectible(itemToRemove) then
+                local numCollectibles = player:GetCollectibleNum(itemToRemove)
+                ____repeat(
+                    nil,
+                    numCollectibles,
+                    function()
+                        player:RemoveCollectible(itemToRemove)
+                        removedItems[#removedItems + 1] = itemToRemove
+                    end
+                )
+            end
+        end
+        mapSetPlayer(nil, removedItemsMap, player, removedItems)
+        local removedTrinkets = {}
+        for ____, trinketToRemove in ipairs(TRINKETS_THAT_AFFECT_ITEM_POOLS) do
+            if player:HasTrinket(trinketToRemove) then
+                local numTrinkets = player:GetTrinketMultiplier(trinketToRemove)
+                ____repeat(
+                    nil,
+                    numTrinkets,
+                    function()
+                        player:TryRemoveTrinket(trinketToRemove)
+                        removedTrinkets[#removedTrinkets + 1] = trinketToRemove
+                    end
+                )
+            end
+        end
+        mapSetPlayer(nil, removedTrinketsMap, player, removedTrinkets)
+    end
+    local itemPool = game:GetItemPool()
+    local collectibleSet = getCollectibleSet(nil)
+    for ____, collectibleType in __TS__Iterator(collectibleSet:values()) do
+        if collectibleType ~= collectibleTypeToCheckFor then
+            itemPool:AddRoomBlacklist(collectibleType)
+        end
+    end
+    local retrievedCollectibleType = itemPool:GetCollectible(itemPoolToCheckFor, false, 1)
+    local collectibleUnlocked = retrievedCollectibleType == collectibleTypeToCheckFor
+    itemPool:ResetRoomBlacklist()
+    for ____, player in ipairs(getPlayers(nil)) do
+        local removedItems = mapGetPlayer(nil, removedItemsMap, player)
+        if removedItems ~= nil then
+            for ____, collectibleType in ipairs(removedItems) do
+                player:AddCollectible(collectibleType, 0, false)
+            end
+        end
+        local removedTrinkets = mapGetPlayer(nil, removedTrinketsMap, player)
+        if removedTrinkets ~= nil then
+            for ____, trinketType in ipairs(removedTrinkets) do
+                player:AddTrinket(trinketType, false)
+            end
+        end
+    end
+    return collectibleUnlocked
+end
+return ____exports

package/index.d.ts

@@ -89,6 +89,7 @@ export * from "./functions/roomGrid";
 export * from "./functions/rooms";
 export * from "./functions/roomShape";
 export * from "./functions/run";
+export * from "./functions/saveFile";
 export * from "./functions/seeds";
 export * from "./functions/serialization";
 export * from "./functions/set";

package/index.lua

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

package/package.json

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