isaacscript-common 1.2.79 → 1.2.82

package/dist/callbacks/postPurchase.lua

@@ -9,8 +9,8 @@ local ____exports = {}
 local hasSubscriptions, postUpdate, checkPickupsPurchased, getPlayerThatIsNoLongerHoldingAnItem, storePickupsInMap, storePlayersInMap, pickupAtIndexStillExists, v
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
-local ____pickups = require("functions.pickups")
-local getPickups = ____pickups.getPickups
+local ____entity = require("functions.entity")
+local getPickups = ____entity.getPickups
 local ____player = require("functions.player")
 local getPlayerIndex = ____player.getPlayerIndex
 local getPlayers = ____player.getPlayers

package/dist/features/deployJSONRoom.d.ts

@@ -10,8 +10,6 @@ import { JSONRoom } from "../types/JSONRoom";
  * @param jsonRoom The JSON room to deploy. In practice, this will be something like:
  * ```
  * import customRooms from "./customRooms";
-import { removeAllPickups } from '../functions/pickups';
-import { removeAllBombs } from '../functions/entitySpecific';
  *
  * const firstJSONRoom = customRooms.rooms.room[0];
  * deployJSONRoom(firstJSONRoom);

package/dist/features/deployJSONRoom.lua

@@ -11,6 +11,7 @@ local ____errors = require("errors")
 local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
 local ____entity = require("functions.entity")
 local removeAllMatchingEntities = ____entity.removeAllMatchingEntities
+local removeAllPickups = ____entity.removeAllPickups
 local ____entitySpecific = require("functions.entitySpecific")
 local removeAllBombs = ____entitySpecific.removeAllBombs
 local ____gridEntity = require("functions.gridEntity")
@@ -27,8 +28,6 @@ local ____math = require("functions.math")
 local range = ____math.range
 local ____npc = require("functions.npc")
 local getNPCs = ____npc.getNPCs
-local ____pickups = require("functions.pickups")
-local removeAllPickups = ____pickups.removeAllPickups
 local ____random = require("functions.random")
 local nextSeed = ____random.nextSeed
 local ____rooms = require("functions.rooms")

package/dist/features/saveDataManager/load.lua

@@ -3,8 +3,8 @@ local ____lualib = require("lualib_bundle")
 local __TS__StringTrim = ____lualib.__TS__StringTrim
 local ____exports = {}
 local readSaveDatFile, tryLoadModData, DEFAULT_MOD_DATA
-local ____json = require("functions.json")
-local jsonDecode = ____json.jsonDecode
+local ____jsonHelpers = require("functions.jsonHelpers")
+local jsonDecode = ____jsonHelpers.jsonDecode
 local ____log = require("functions.log")
 local log = ____log.log
 local ____debug = require("features.saveDataManager.debug")

package/dist/features/saveDataManager/save.lua

@@ -7,8 +7,8 @@ local getAllSaveDataToWriteToDisk
 local ____deepCopy = require("functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
 local SerializationType = ____deepCopy.SerializationType
-local ____json = require("functions.json")
-local jsonEncode = ____json.jsonEncode
+local ____jsonHelpers = require("functions.jsonHelpers")
+local jsonEncode = ____jsonHelpers.jsonEncode
 local ____log = require("functions.log")
 local log = ____log.log
 function getAllSaveDataToWriteToDisk(self, saveDataMap, saveDataConditionalFuncMap)

package/dist/functions/collectibles.lua

@@ -8,11 +8,11 @@ local ____collectibleDescriptionMap = require("maps.collectibleDescriptionMap")
 local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DESCRIPTION_MAP
 local ____collectibleNameMap = require("maps.collectibleNameMap")
 local COLLECTIBLE_NAME_MAP = ____collectibleNameMap.COLLECTIBLE_NAME_MAP
+local ____entity = require("functions.entity")
+local getPickups = ____entity.getPickups
+local removeAllPickups = ____entity.removeAllPickups
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-local ____pickups = require("functions.pickups")
-local getPickups = ____pickups.getPickups
-local removeAllPickups = ____pickups.removeAllPickups
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
 function ____exports.setCollectibleSprite(self, collectible, pngPath)

package/dist/functions/entity.d.ts

@@ -42,6 +42,18 @@ export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities:
  * returned. False by default. Will only be taken into account if `matchingEntityType` is specified.
  */
 export declare function getEntities(matchingEntityType?: EntityType | int, matchingVariant?: number, matchingSubType?: number, ignoreFriendly?: boolean): Entity[];
+/**
+ * Helper function to get all of the pickups in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the pickups in the room invisible
+ * for (const pickup of getPickups()) {
+ *   pickup.Visible = false;
+ * }
+ * ```
+ */
+export declare function getPickups(matchingVariant?: PickupVariant | int, matchingSubType?: number): EntityPickup[];
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *
@@ -55,6 +67,14 @@ export declare function isEntityMoving(entity: Entity, threshold?: number): bool
  * to non-story bosses, like Vanishing Twin. Also see the `STORY_BOSSES` constant.
  */
 export declare function isStoryBoss(entity: Entity): boolean;
+/**
+ * Helper function to remove all of the entities in the supplied array.
+ *
+ * @param entities The array of entities to remove.
+ * @param cap Optional. If specified, will only remove the given amount of entities.
+ * @returns True if one or more entities was removed, false otherwise.
+ */
+export declare function removeEntities(entities: Entity[], cap?: int): boolean;
 /**
  * Helper function to remove all of the matching entities in the room.
  *
@@ -68,13 +88,14 @@ export declare function isStoryBoss(entity: Entity): boolean;
  */
 export declare function removeAllMatchingEntities(entityType: int, entityVariant?: number, entitySubType?: number, cap?: int | undefined): boolean;
 /**
- * Helper function to remove all of the entities in the supplied array.
+ * Helper function to remove all of the pickups in the room.
  *
- * @param entities The array of entities to remove.
- * @param cap Optional. If specified, will only remove the given amount of entities.
- * @returns True if one or more entities was removed, false otherwise.
+ * @param variant Optional. If specified, will only remove pickups that match this variant.
+ * @param subType Optional. If specified, will only remove pickups that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of pickups.
+ * @returns True if one or more pickups was removed, false otherwise.
  */
-export declare function removeEntities(entities: Entity[], cap?: int): boolean;
+export declare function removeAllPickups(variant?: PickupVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to reroll an enemy. Use this instead of the vanilla "Game.RerollEnemy" function
  * if you want the rerolled enemy to be returned.

package/dist/functions/entity.lua

@@ -13,20 +13,6 @@ local getRandom = ____random.getRandom
 local nextSeed = ____random.nextSeed
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
-function ____exports.removeEntities(self, entities, cap)
-    if #entities == 0 then
-        return false
-    end
-    local numEntitiesRemoved = 0
-    for ____, entity in ipairs(entities) do
-        entity:Remove()
-        numEntitiesRemoved = numEntitiesRemoved + 1
-        if cap ~= nil and numEntitiesRemoved >= cap then
-            return true
-        end
-    end
-    return true
-end
 function ____exports.anyEntityCloserThan(self, entities, position, distance)
     return __TS__ArraySome(
         entities,
@@ -77,6 +63,23 @@ function ____exports.getEntities(self, matchingEntityType, matchingVariant, matc
     end
     return Isaac.FindByType(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
 end
+function ____exports.getPickups(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local entities = ____exports.getEntities(nil, EntityType.ENTITY_PICKUP, matchingVariant, matchingSubType)
+    local pickups = {}
+    for ____, entity in ipairs(entities) do
+        local pickup = entity:ToPickup()
+        if pickup ~= nil then
+            __TS__ArrayPush(pickups, pickup)
+        end
+    end
+    return pickups
+end
 function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
         threshold = 0.01
@@ -86,6 +89,20 @@ end
 function ____exports.isStoryBoss(self, entity)
     return STORY_BOSSES:has(entity.Type)
 end
+function ____exports.removeEntities(self, entities, cap)
+    if #entities == 0 then
+        return false
+    end
+    local numEntitiesRemoved = 0
+    for ____, entity in ipairs(entities) do
+        entity:Remove()
+        numEntitiesRemoved = numEntitiesRemoved + 1
+        if cap ~= nil and numEntitiesRemoved >= cap then
+            return true
+        end
+    end
+    return true
+end
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
     if entityVariant == nil then
         entityVariant = -1
@@ -99,6 +116,10 @@ function ____exports.removeAllMatchingEntities(self, entityType, entityVariant,
     local entities = ____exports.getEntities(nil, entityType, entityVariant, entitySubType)
     return ____exports.removeEntities(nil, entities, cap)
 end
+function ____exports.removeAllPickups(self, variant, subType, cap)
+    local pickups = ____exports.getPickups(nil, variant, subType)
+    return ____exports.removeEntities(nil, pickups, cap)
+end
 function ____exports.rerollEnemy(self, entity)
     local game = Game()
     local oldEntities = ____exports.getEntities(nil)

package/dist/functions/jsonHelpers.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * Converts a Lua table to a JSON string.
+ * In most cases, this function will be used for writing data to a "save#.dat" file.
+ * If encoding fails, it will throw an error to prevent writing a blank string or corrupted data to
+ * a user's "save#.dat" file.
+ */
+export declare function jsonEncode(table: unknown): string;
+/**
+ * Converts a JSON string to a Lua table.
+ * In most cases, this function will be used for reading data from a "save#.dat" file.
+ * If decoding fails, it will return a blank Lua table instead of throwing an error.
+ * (This allows execution to continue in cases where users have no current save data or have
+ * manually removed their existing save data.)
+ */
+export declare function jsonDecode(jsonString: string): LuaTable;

package/dist/functions/jsonHelpers.lua

@@ -0,0 +1,28 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local tryEncode, tryDecode
+local json = require("@NoResolution:json")
+local ____log = require("functions.log")
+local log = ____log.log
+function tryEncode(____table)
+    return json.encode(____table)
+end
+function tryDecode(jsonString)
+    return json.decode(jsonString)
+end
+function ____exports.jsonEncode(self, ____table)
+    local ok, jsonStringOrErrMsg = pcall(tryEncode, ____table)
+    if not ok then
+        error("Failed to convert the Lua table to JSON: " .. jsonStringOrErrMsg)
+    end
+    return jsonStringOrErrMsg
+end
+function ____exports.jsonDecode(self, jsonString)
+    local ok, luaTableOrErrMsg = pcall(tryDecode, jsonString)
+    if not ok then
+        log("Failed to convert the JSON string to a Lua table: " .. jsonString)
+        return {}
+    end
+    return luaTableOrErrMsg
+end
+return ____exports

package/dist/functions/pickups.d.ts

@@ -1,16 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
-/**
- * Helper function to get all of the pickups in the room.
- *
- * Example:
- * ```
- * // Make all of the pickups in the room invisible
- * for (const pickup of getPickups()) {
- *   pickup.Visible = false;
- * }
- * ```
- */
-export declare function getPickups(matchingVariant?: PickupVariant | int, matchingSubType?: number): EntityPickup[];
 /**
  * Has as an equal chance of returning any value in the `HeartSubType` enum. Useful for spawning a random type of heart.
  *
@@ -19,12 +7,3 @@ export declare function getPickups(matchingVariant?: PickupVariant | int, matchi
  */
 export declare function getRandomHeartSubType(seed?: number, exceptions?: HeartSubType[]): HeartSubType;
 export declare function isChest(pickup: EntityPickup): boolean;
-/**
- * Helper function to remove all of the pickups in the room.
- *
- * @param variant Optional. If specified, will only remove pickups that match this variant.
- * @param subType Optional. If specified, will only remove pickups that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of pickups.
- * @returns True if one or more pickups was removed, false otherwise.
- */
-export declare function removeAllPickups(variant?: PickupVariant | int, subType?: int, cap?: int): boolean;

package/dist/functions/pickups.lua

@@ -1,33 +1,11 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
-local ____lualib = require("lualib_bundle")
-local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
 local ____constants = require("constants")
 local CHEST_PICKUP_VARIANTS = ____constants.CHEST_PICKUP_VARIANTS
 local ____array = require("functions.array")
 local getRandomArrayElement = ____array.getRandomArrayElement
-local ____entity = require("functions.entity")
-local getEntities = ____entity.getEntities
-local removeEntities = ____entity.removeEntities
 local ____utils = require("functions.utils")
 local getEnumValues = ____utils.getEnumValues
-function ____exports.getPickups(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    local entities = getEntities(nil, EntityType.ENTITY_PICKUP, matchingVariant, matchingSubType)
-    local pickups = {}
-    for ____, entity in ipairs(entities) do
-        local pickup = entity:ToPickup()
-        if pickup ~= nil then
-            __TS__ArrayPush(pickups, pickup)
-        end
-    end
-    return pickups
-end
 function ____exports.getRandomHeartSubType(self, seed, exceptions)
     if seed == nil then
         seed = Random()
@@ -41,8 +19,4 @@ end
 function ____exports.isChest(self, pickup)
     return CHEST_PICKUP_VARIANTS:has(pickup.Variant)
 end
-function ____exports.removeAllPickups(self, variant, subType, cap)
-    local pickups = ____exports.getPickups(nil, variant, subType)
-    return removeEntities(nil, pickups, cap)
-end
 return ____exports

package/dist/functions/player.d.ts

@@ -97,9 +97,9 @@ export declare function getLastHeart(player: EntityPlayer): HealthType;
  */
 export declare function getNewestPlayer(): EntityPlayer;
 /**
- * Returns the number of slots that the player has remaining for heart containers, accounting for
- * broken hearts. For example, if the player is Judas and has 1 red heart containers and 2 full soul
- * hearts and 3 broken hearts, then this function would return 6 (i.e. 12 - 1 - 2 - 3).
+ * Returns the number of slots that the player has remaining for new heart containers, accounting
+ * for broken hearts. For example, if the player is Judas and has 1 red heart containers and 2 full
+ * soul hearts and 3 broken hearts, then this function would return 6 (i.e. 12 - 1 - 2 - 3).
  */
 export declare function getPlayerAvailableHeartSlots(player: EntityPlayer): int;
 /**

package/dist/functions/revive.d.ts

@@ -5,8 +5,8 @@
  */
 export declare function isDamageToPlayerFatal(player: EntityPlayer, damageAmount: int, damageSource: EntityRef, lastDamageGameFrame: int): boolean;
 /**
- * The `EntityPlayer.WillPlayerRevive()` function does not properly account for Mysterious Paper,
- * so use this helper function instead for more robust revival detection.
+ * The `EntityPlayer.WillPlayerRevive()` function does not properly account for Mysterious Paper, so
+ * use this helper function instead for more robust revival detection.
  */
 export declare function willPlayerRevive(player: EntityPlayer): boolean;
 /**
@@ -18,6 +18,12 @@ export declare function willPlayerRevive(player: EntityPlayer): boolean;
  * Mysterious Paper be Missing Power is: `gameFrameCount % 4 === 3`
  */
 export declare function willMysteriousPaperRevive(player: EntityPlayer): boolean;
+/**
+ * Helper function to determine if the player will be revived by the Heartbreak collectible if they
+ * take fatal damage. This is contingent on the character that they are playing as and the amount of
+ * broken hearts that they already have.
+ */
+export declare function willReviveFromHeartbreak(player: EntityPlayer): boolean;
 /**
  * Helper function to determine if the Spirit Shackles item is in an enabled state. (It can be
  * either enabled or disabled.)

package/dist/functions/revive.lua

@@ -2,9 +2,10 @@
 local ____exports = {}
 local ____player = require("functions.player")
 local getDeathAnimationName = ____player.getDeathAnimationName
-local getPlayerAvailableHeartSlots = ____player.getPlayerAvailableHeartSlots
+local getPlayerMaxHeartContainers = ____player.getPlayerMaxHeartContainers
 local getPlayerNumHitsRemaining = ____player.getPlayerNumHitsRemaining
 local hasLostCurse = ____player.hasLostCurse
+local isKeeper = ____player.isKeeper
 local ____sprite = require("functions.sprite")
 local getFinalFrameOfAnimation = ____sprite.getFinalFrameOfAnimation
 local ____trinketGive = require("functions.trinketGive")
@@ -19,6 +20,16 @@ function ____exports.willMysteriousPaperRevive(self, player)
     local frameOfDeath = gameFrameCount + deathAnimationFrames + 1
     return frameOfDeath % 4 == 3
 end
+function ____exports.willReviveFromHeartbreak(self, player)
+    if player:HasCollectible(CollectibleType.COLLECTIBLE_HEARTBREAK) then
+        return false
+    end
+    local numBrokenHeartsThatWillBeAdded = isKeeper(nil, player) and 1 or 2
+    local brokenHearts = player:GetBrokenHearts()
+    local numBrokenHeartsAfterRevival = numBrokenHeartsThatWillBeAdded + brokenHearts
+    local maxHeartContainers = getPlayerMaxHeartContainers(nil, player)
+    return numBrokenHeartsAfterRevival < maxHeartContainers
+end
 function ____exports.willReviveFromSpiritShackles(self, player)
     if not player:HasCollectible(CollectibleType.COLLECTIBLE_SPIRIT_SHACKLES) then
         return false
@@ -53,8 +64,7 @@ function ____exports.isDamageToPlayerFatal(self, player, damageAmount, damageSou
     if damageAmount < playerNumAllHearts then
         return false
     end
-    local playerAvailableHeartSlots = getPlayerAvailableHeartSlots(nil, player)
-    if player:HasCollectible(CollectibleType.COLLECTIBLE_HEARTBREAK) and playerAvailableHeartSlots >= 2 then
+    if ____exports.willReviveFromHeartbreak(nil, player) then
         return false
     end
     if player:HasCollectible(CollectibleType.COLLECTIBLE_BROKEN_GLASS_CANNON) and gameFrameCount == lastDamageGameFrame then

package/dist/functions/trinkets.lua

@@ -6,10 +6,10 @@ local ____trinketDescriptionMap = require("maps.trinketDescriptionMap")
 local TRINKET_DESCRIPTION_MAP = ____trinketDescriptionMap.TRINKET_DESCRIPTION_MAP
 local ____trinketNameMap = require("maps.trinketNameMap")
 local TRINKET_NAME_MAP = ____trinketNameMap.TRINKET_NAME_MAP
+local ____entity = require("functions.entity")
+local getPickups = ____entity.getPickups
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-local ____pickups = require("functions.pickups")
-local getPickups = ____pickups.getPickups
 local ____player = require("functions.player")
 local useActiveItemTemp = ____player.useActiveItemTemp
 local ____trinketGive = require("functions.trinketGive")

package/dist/index.d.ts

@@ -29,7 +29,7 @@ export * from "./functions/flying";
 export * from "./functions/globals";
 export * from "./functions/gridEntity";
 export * from "./functions/input";
-export * from "./functions/json";
+export * from "./functions/jsonHelpers";
 export * from "./functions/jsonRoom";
 export * from "./functions/language";
 export * from "./functions/log";

package/dist/index.lua

@@ -243,7 +243,7 @@ do
     end
 end
 do
-    local ____export = require("functions.json")
+    local ____export = require("functions.jsonHelpers")
     for ____exportKey, ____exportValue in pairs(____export) do
         if ____exportKey ~= "default" then
             ____exports[____exportKey] = ____exportValue

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.79",
+  "version": "1.2.82",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",