isaacscript-common 3.1.0 → 3.3.0

package/functions/playerHealth.lua

@@ -1,4 +1,5 @@
 local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
@@ -16,6 +17,79 @@ local isCharacter = ____player.isCharacter
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 local ____repeat = ____utils["repeat"]
+function ____exports.removeAllPlayerHealth(self, player)
+    local goldenHearts = player:GetGoldenHearts()
+    local eternalHearts = player:GetEternalHearts()
+    local boneHearts = player:GetBoneHearts()
+    local brokenHearts = player:GetBrokenHearts()
+    player:AddGoldenHearts(goldenHearts * -1)
+    player:AddEternalHearts(eternalHearts * -1)
+    player:AddBoneHearts(boneHearts * -1)
+    player:AddBrokenHearts(brokenHearts * -1)
+    player:AddMaxHearts(MAX_PLAYER_HEART_CONTAINERS * -2, true)
+    player:AddSoulHearts(MAX_PLAYER_HEART_CONTAINERS * -2)
+    if isCharacter(nil, player, PlayerType.THE_SOUL) then
+        local forgotten = player:GetSubPlayer()
+        if forgotten ~= nil then
+            local forgottenBoneHearts = forgotten:GetBoneHearts()
+            forgotten:AddBoneHearts(forgottenBoneHearts * -1)
+        end
+    end
+end
+--- Helper function to set a player's health to a specific state. You can use this in combination
+-- with the `getPlayerHealth` function to restore the player's health back to a certain
+-- configuration at a later time.
+-- 
+-- Based on the `REVEL.LoadHealth` function in the Revelations mod.
+function ____exports.setPlayerHealth(self, player, playerHealth)
+    local character = player:GetPlayerType()
+    local subPlayer = player:GetSubPlayer()
+    ____exports.removeAllPlayerHealth(nil, player)
+    if character == PlayerType.THE_SOUL and subPlayer ~= nil then
+        subPlayer:AddMaxHearts(playerHealth.maxHearts, false)
+    else
+        player:AddMaxHearts(playerHealth.maxHearts, false)
+    end
+    player:AddEternalHearts(playerHealth.eternalHearts)
+    local soulHeartsRemaining = playerHealth.soulHearts
+    __TS__ArrayForEach(
+        playerHealth.soulHeartTypes,
+        function(____, heartType, i)
+            local isHalf = playerHealth.soulHearts + playerHealth.boneHearts * 2 < (i + 1) * 2
+            local addAmount = 2
+            if isHalf or heartType == HeartSubType.BONE or soulHeartsRemaining < 2 then
+                addAmount = 1
+            end
+            if heartType == HeartSubType.SOUL then
+                player:AddSoulHearts(addAmount)
+                soulHeartsRemaining = soulHeartsRemaining - addAmount
+            elseif heartType == HeartSubType.BLACK then
+                player:AddBlackHearts(addAmount)
+                soulHeartsRemaining = soulHeartsRemaining - addAmount
+            elseif heartType == HeartSubType.BONE then
+                player:AddBoneHearts(addAmount)
+            end
+        end
+    )
+    player:AddRottenHearts(playerHealth.rottenHearts)
+    ____repeat(
+        nil,
+        playerHealth.hearts,
+        function()
+            player:AddHearts(1)
+            if character == PlayerType.MAGDALENE_B then
+                player:AddHearts(-1)
+            end
+        end
+    )
+    player:AddGoldenHearts(playerHealth.goldenHearts)
+    player:AddBrokenHearts(playerHealth.brokenHearts)
+    if character == PlayerType.BETHANY then
+        player:SetSoulCharge(playerHealth.soulCharges)
+    elseif character == PlayerType.BETHANY_B then
+        player:SetBloodCharge(playerHealth.bloodCharges)
+    end
+end
 function ____exports.addPlayerHealthType(self, player, healthType, numHearts)
     repeat
         local ____switch3 = healthType
@@ -220,77 +294,22 @@ function ____exports.getPlayerHealthType(self, player, healthType)
         end
     until true
 end
-function ____exports.removeAllPlayerHealth(self, player)
-    local goldenHearts = player:GetGoldenHearts()
-    local eternalHearts = player:GetEternalHearts()
-    local boneHearts = player:GetBoneHearts()
-    local brokenHearts = player:GetBrokenHearts()
-    player:AddGoldenHearts(goldenHearts * -1)
-    player:AddEternalHearts(eternalHearts * -1)
-    player:AddBoneHearts(boneHearts * -1)
-    player:AddBrokenHearts(brokenHearts * -1)
-    player:AddMaxHearts(MAX_PLAYER_HEART_CONTAINERS * -2, true)
-    player:AddSoulHearts(MAX_PLAYER_HEART_CONTAINERS * -2)
-    if isCharacter(nil, player, PlayerType.THE_SOUL) then
-        local forgotten = player:GetSubPlayer()
-        if forgotten ~= nil then
-            local forgottenBoneHearts = forgotten:GetBoneHearts()
-            forgotten:AddBoneHearts(forgottenBoneHearts * -1)
-        end
-    end
-end
---- Helper function to set a player's health to a specific state. You can use this in combination
--- with the `getPlayerHealth` function to restore the player's health back to a certain
--- configuration at a later time.
--- 
--- Based on the `REVEL.LoadHealth` function in the Revelations mod.
-function ____exports.setPlayerHealth(self, player, playerHealth)
-    local character = player:GetPlayerType()
-    local subPlayer = player:GetSubPlayer()
+function ____exports.playerConvertBlackHeartsToSoulHearts(self, player)
+    local playerHealth = ____exports.getPlayerHealth(nil, player)
     ____exports.removeAllPlayerHealth(nil, player)
-    if character == PlayerType.THE_SOUL and subPlayer ~= nil then
-        subPlayer:AddMaxHearts(playerHealth.maxHearts, false)
-    else
-        player:AddMaxHearts(playerHealth.maxHearts, false)
-    end
-    player:AddEternalHearts(playerHealth.eternalHearts)
-    local soulHeartsRemaining = playerHealth.soulHearts
-    __TS__ArrayForEach(
+    playerHealth.soulHeartTypes = __TS__ArrayMap(
         playerHealth.soulHeartTypes,
-        function(____, heartType, i)
-            local isHalf = playerHealth.soulHearts + playerHealth.boneHearts * 2 < (i + 1) * 2
-            local addAmount = 2
-            if isHalf or heartType == HeartSubType.BONE or soulHeartsRemaining < 2 then
-                addAmount = 1
-            end
-            if heartType == HeartSubType.SOUL then
-                player:AddSoulHearts(addAmount)
-                soulHeartsRemaining = soulHeartsRemaining - addAmount
-            elseif heartType == HeartSubType.BLACK then
-                player:AddBlackHearts(addAmount)
-                soulHeartsRemaining = soulHeartsRemaining - addAmount
-            elseif heartType == HeartSubType.BONE then
-                player:AddBoneHearts(addAmount)
-            end
-        end
+        function(____, soulHeartType) return soulHeartType == HeartSubType.BLACK and HeartSubType.SOUL or soulHeartType end
     )
-    player:AddRottenHearts(playerHealth.rottenHearts)
-    ____repeat(
-        nil,
-        playerHealth.hearts,
-        function()
-            player:AddHearts(1)
-            if character == PlayerType.MAGDALENE_B then
-                player:AddHearts(-1)
-            end
-        end
+    ____exports.setPlayerHealth(nil, player, playerHealth)
+end
+function ____exports.playerConvertSoulHeartsToBlackHearts(self, player)
+    local playerHealth = ____exports.getPlayerHealth(nil, player)
+    ____exports.removeAllPlayerHealth(nil, player)
+    playerHealth.soulHeartTypes = __TS__ArrayMap(
+        playerHealth.soulHeartTypes,
+        function(____, soulHeartType) return soulHeartType == HeartSubType.SOUL and HeartSubType.BLACK or soulHeartType end
     )
-    player:AddGoldenHearts(playerHealth.goldenHearts)
-    player:AddBrokenHearts(playerHealth.brokenHearts)
-    if character == PlayerType.BETHANY then
-        player:SetSoulCharge(playerHealth.soulCharges)
-    elseif character == PlayerType.BETHANY_B then
-        player:SetBloodCharge(playerHealth.bloodCharges)
-    end
+    ____exports.setPlayerHealth(nil, player, playerHealth)
 end
 return ____exports

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

@@ -20,6 +20,7 @@ export { removeFadeIn, restoreFadeIn } from "./features/fadeInRemover";
 export { disableFastReset, enableFastReset } from "./features/fastReset";
 export { forgottenSwitch } from "./features/forgottenSwitch";
 export { getCollectibleItemPoolType } from "./features/getCollectibleItemPoolType";
+export { removePersistentEntity, spawnPersistentEntity, } from "./features/persistentEntities";
 export { addCollectible, getPlayerInventory } from "./features/playerInventory";
 export * from "./features/ponyDetection";
 export { preventCollectibleRotation } from "./features/preventCollectibleRotation";
@@ -30,6 +31,7 @@ export { getTaintedLazarusSubPlayer } from "./features/taintedLazarusPlayers";
 export * from "./functions/array";
 export * from "./functions/benchmark";
 export * from "./functions/bitwise";
+export * from "./functions/bombs";
 export * from "./functions/boss";
 export * from "./functions/cacheFlag";
 export * from "./functions/cards";
@@ -88,6 +90,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

@@ -167,6 +167,13 @@ do
     local getCollectibleItemPoolType = ____getCollectibleItemPoolType.getCollectibleItemPoolType
     ____exports.getCollectibleItemPoolType = getCollectibleItemPoolType
 end
+do
+    local ____persistentEntities = require("features.persistentEntities")
+    local removePersistentEntity = ____persistentEntities.removePersistentEntity
+    local spawnPersistentEntity = ____persistentEntities.spawnPersistentEntity
+    ____exports.removePersistentEntity = removePersistentEntity
+    ____exports.spawnPersistentEntity = spawnPersistentEntity
+end
 do
     local ____playerInventory = require("features.playerInventory")
     local addCollectible = ____playerInventory.addCollectible
@@ -242,6 +249,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.bombs")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.boss")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -697,6 +712,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/initCustomCallbacks.lua

@@ -51,6 +51,8 @@ local ____postNPCStateChanged = require("callbacks.postNPCStateChanged")
 local postNPCStateChangedCallbackInit = ____postNPCStateChanged.postNPCStateChangedCallbackInit
 local ____postPickupCollect = require("callbacks.postPickupCollect")
 local postPickupCollectCallbackInit = ____postPickupCollect.postPickupCollectCallbackInit
+local ____postPickupInitFirst = require("callbacks.postPickupInitFirst")
+local postPickupInitFirstCallbackInit = ____postPickupInitFirst.postPickupInitFirstCallbackInit
 local ____postPickupInitLate = require("callbacks.postPickupInitLate")
 local postPickupInitLateCallbackInit = ____postPickupInitLate.postPickupInitLateCallbackInit
 local ____postPickupStateChanged = require("callbacks.postPickupStateChanged")
@@ -144,6 +146,7 @@ function ____exports.initCustomCallbacks(self, mod)
     postNPCInitLateCallbackInit(nil, mod)
     postNPCStateChangedCallbackInit(nil, mod)
     postPickupCollectCallbackInit(nil, mod)
+    postPickupInitFirstCallbackInit(nil, mod)
     postPickupInitLateCallbackInit(nil, mod)
     postPickupStateChangedCallbackInit(nil, mod)
     postPitRenderInit(nil, mod)

package/initFeatures.lua

@@ -17,6 +17,8 @@ local ____forgottenSwitch = require("features.forgottenSwitch")
 local forgottenSwitchInit = ____forgottenSwitch.forgottenSwitchInit
 local ____getCollectibleItemPoolType = require("features.getCollectibleItemPoolType")
 local getCollectibleItemPoolTypeInit = ____getCollectibleItemPoolType.getCollectibleItemPoolTypeInit
+local ____persistentEntities = require("features.persistentEntities")
+local persistentEntitiesInit = ____persistentEntities.persistentEntitiesInit
 local ____playerInventory = require("features.playerInventory")
 local playerInventoryInit = ____playerInventory.playerInventoryInit
 local ____ponyDetection = require("features.ponyDetection")
@@ -42,6 +44,7 @@ function ____exports.initFeaturesMinor(self, mod)
     fastResetInit(nil, mod)
     forgottenSwitchInit(nil, mod)
     getCollectibleItemPoolTypeInit(nil, mod)
+    persistentEntitiesInit(nil, mod)
     playerInventoryInit(nil, mod)
     ponyDetectionInit(nil, mod)
     preventCollectibleRotationInit(nil, mod)

package/interfaces/AddCallbackParameterCustom.d.ts

@@ -35,6 +35,7 @@ import { PostNPCInitLateRegisterParameters } from "../callbacks/subscriptions/po
 import { PostNPCStateChangedRegisterParameters } from "../callbacks/subscriptions/postNPCStateChanged";
 import { PostPEffectUpdateReorderedRegisterParameters } from "../callbacks/subscriptions/postPEffectUpdateReordered";
 import { PostPickupCollectRegisterParameters } from "../callbacks/subscriptions/postPickupCollect";
+import { PostPickupInitFirstRegisterParameters } from "../callbacks/subscriptions/postPickupInitFirst";
 import { PostPickupInitLateRegisterParameters } from "../callbacks/subscriptions/postPickupInitLate";
 import { PostPickupStateChangedRegisterParameters } from "../callbacks/subscriptions/postPickupStateChanged";
 import { PostPitRenderRegisterParameters } from "../callbacks/subscriptions/postPitRender";
@@ -112,6 +113,7 @@ export interface AddCallbackParameterCustom {
     [ModCallbackCustom.POST_NPC_STATE_CHANGED]: PostNPCStateChangedRegisterParameters;
     [ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED]: PostPEffectUpdateReorderedRegisterParameters;
     [ModCallbackCustom.POST_PICKUP_COLLECT]: PostPickupCollectRegisterParameters;
+    [ModCallbackCustom.POST_PICKUP_INIT_FIRST]: PostPickupInitFirstRegisterParameters;
     [ModCallbackCustom.POST_PICKUP_INIT_LATE]: PostPickupInitLateRegisterParameters;
     [ModCallbackCustom.POST_PICKUP_STATE_CHANGED]: PostPickupStateChangedRegisterParameters;
     [ModCallbackCustom.POST_PIT_RENDER]: PostPitRenderRegisterParameters;

package/objects/callbackRegisterFunctions.lua

@@ -73,6 +73,8 @@ local ____postPEffectUpdateReordered = require("callbacks.subscriptions.postPEff
 local postPEffectUpdateReorderedRegister = ____postPEffectUpdateReordered.postPEffectUpdateReorderedRegister
 local ____postPickupCollect = require("callbacks.subscriptions.postPickupCollect")
 local postPickupCollectRegister = ____postPickupCollect.postPickupCollectRegister
+local ____postPickupInitFirst = require("callbacks.subscriptions.postPickupInitFirst")
+local postPickupInitFirstRegister = ____postPickupInitFirst.postPickupInitFirstRegister
 local ____postPickupInitLate = require("callbacks.subscriptions.postPickupInitLate")
 local postPickupInitLateRegister = ____postPickupInitLate.postPickupInitLateRegister
 local ____postPickupStateChanged = require("callbacks.subscriptions.postPickupStateChanged")
@@ -189,6 +191,7 @@ ____exports.CALLBACK_REGISTER_FUNCTIONS = {
     [ModCallbackCustom.POST_NPC_STATE_CHANGED] = postNPCStateChangedRegister,
     [ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED] = postPEffectUpdateReorderedRegister,
     [ModCallbackCustom.POST_PICKUP_COLLECT] = postPickupCollectRegister,
+    [ModCallbackCustom.POST_PICKUP_INIT_FIRST] = postPickupInitFirstRegister,
     [ModCallbackCustom.POST_PICKUP_INIT_LATE] = postPickupInitLateRegister,
     [ModCallbackCustom.POST_PICKUP_STATE_CHANGED] = postPickupStateChangedRegister,
     [ModCallbackCustom.POST_PIT_RENDER] = postPitRenderRegister,

package/package.json

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