isaacscript-common 1.2.251 → 1.2.254

package/dist/features/saveDataManager/merge.lua

@@ -36,7 +36,9 @@ function ____exports.merge(self, oldObject, newTable, traversalDescription)
     if newTableType ~= "table" then
         error("The second argument given to the merge function is not a table.")
     end
-    if mergeArray(nil, oldObject, newTable) then
+    if isArray(nil, oldObject) and isArray(nil, newTable) then
+        local oldTable = oldObject
+        mergeArray(nil, oldTable, newTable)
         return
     end
     if __TS__InstanceOf(oldObject, Map) or __TS__InstanceOf(oldObject, Set) then
@@ -45,16 +47,11 @@ function ____exports.merge(self, oldObject, newTable, traversalDescription)
         mergeTable(nil, oldObject, newTable, traversalDescription)
     end
 end
-function mergeArray(self, oldObject, newTable)
-    local oldArray = oldObject
-    if not isArray(nil, oldArray) or not isArray(nil, newTable) then
-        return false
-    end
+function mergeArray(self, oldArray, newArray)
     clearTable(nil, oldArray)
-    for key, value in pairs(newTable) do
+    for key, value in pairs(newArray) do
         oldArray[key] = value
     end
-    return true
 end
 function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
     oldObject:clear()
@@ -62,13 +59,13 @@ function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
     for key, value in pairs(newTable) do
         do
             if isSerializationBrand(nil, key) then
-                goto __continue13
+                goto __continue12
             end
             local keyToUse = key
             if convertStringKeysToNumbers then
                 local numberKey = tonumber(key)
                 if numberKey == nil then
-                    goto __continue13
+                    goto __continue12
                 end
                 keyToUse = numberKey
             end
@@ -85,13 +82,10 @@ function mergeTSTLObject(self, oldObject, newTable, traversalDescription)
                 oldObject:add(keyToUse)
             end
         end
-        ::__continue13::
+        ::__continue12::
     end
 end
 function mergeTable(self, oldTable, newTable, traversalDescription)
-    if SAVE_DATA_MANAGER_DEBUG then
-        log("merge is operating on a table. Iterating through the keys...")
-    end
     for key, value in pairs(newTable) do
         do
             if SAVE_DATA_MANAGER_DEBUG then
@@ -99,7 +93,7 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
                 log((("merge is merging: " .. traversalDescription) .. " --> ") .. valueToPrint)
             end
             if isSerializationBrand(nil, key) then
-                goto __continue23
+                goto __continue21
             end
             if isSerializedIsaacAPIClass(nil, value) then
                 if SAVE_DATA_MANAGER_DEBUG then
@@ -107,7 +101,7 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
                 end
                 local deserializedObject = deserializeIsaacAPIClass(nil, value)
                 oldTable[key] = deserializedObject
-                goto __continue23
+                goto __continue21
             end
             local valueType = type(value)
             if valueType == "table" then
@@ -123,7 +117,7 @@ function mergeTable(self, oldTable, newTable, traversalDescription)
                 oldTable[key] = value
             end
         end
-        ::__continue23::
+        ::__continue21::
     end
 end
 return ____exports

package/dist/functions/familiars.d.ts

@@ -1,33 +1,40 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to add and remove familiars based on a target amount that you specify. Use this
- * instead of the `EntityPlayer.CheckFamiliar` method so that the InitSeed of the spawned familiar
- * will be set properly. Note that when using this function, you need to manually account for Box of
- * Friends and Monster Manual (by looking at the number of collectible effects for the familiar).
+ * Helper function to add and remove familiars based on a target amount that you specify.
+ *
+ * This is a convenience wrapper around the `EntityPlayer.CheckFamiliar` method. Use this helper
+ * function instead so that you do not have to retrieve the `ItemConfigItem` and so that you do not
+ * specify an incorrect RNG object. (The vanilla method is bugged in that it does not increment the
+ * RNG object; see the documentation of the method for more details.)
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
  * to `CacheFlag.CACHE_FAMILIARS`).
  *
- * Note that this function is only meant to be used in special circumstances. For general purpose
- * usage, please use the `checkFamiliarFromCollectibles` helper function instead.
+ * Note that this function is only meant to be used in special circumstances where the familiar
+ * count is completely custom and does not correspond to the amount of collectibles. For the general
+ * case, use the `checkFamiliarFromCollectibles` helper function instead.
+ *
+ * Note that this will spawn familiars with a completely random `InitSeed`. When calculating random
+ * events for this familiar, you should use a data structure that maps familiar `InitSeed` to RNG
+ * objects that are initialized based on the seed from
+ * `EntityPlayer.GetCollectibleRNG(collectibleType)`.
  *
  * @param player The player that owns the familiars.
  * @param collectibleType The collectible type of the collectible associated with this familiar.
- * @param numTargetFamiliars The number of familiars that should exist. This function will add or
- * remove familiars until it matches the target count.
+ * @param targetCount The number of familiars that should exist. This function will add or remove
+ * familiars until it matches the target count.
  * @param familiarVariant The variant of the familiar to spawn or remove.
  * @param familiarSubType Optional. The sub-type of the familiar to spawn or remove. If not
  * specified, it will search for existing familiars of all sub-types, and spawn new familiars with a
  * sub-type of 0.
- * @returns The amount of familiars that were added or removed. For example, the player has 0
- * collectibles and there were 2 familiars, this function would remove the 2 familiars and return
- * -2.
  */
-export declare function checkFamiliar(player: EntityPlayer, collectibleType: int, numTargetFamiliars: int, familiarVariant: int, familiarSubType?: int): int;
+export declare function checkFamiliar(player: EntityPlayer, collectibleType: int, targetCount: int, familiarVariant: int, familiarSubType?: int): void;
 /**
  * Helper function to add and remove familiars based on the amount of associated collectibles that a
- * player has. Use this instead of the `EntityPlayer.CheckFamiliar` method so that the InitSeed of
- * the spawned familiar will be set properly and Box of Friends is handled automatically.
+ * player has.
+ *
+ * Use this helper function instead of invoking the `EntityPlayer.CheckFamiliar` method directly so
+ * that the target count is handled automatically.
  *
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
  * to `CacheFlag.CACHE_FAMILIARS`).
@@ -37,15 +44,17 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: int
  * Manual). If you instead need to have a custom amount of familiars, use the `checkFamiliars`
  * function instead.
  *
+ * Note that this will spawn familiars with a completely random `InitSeed`. When calculating random
+ * events for this familiar, you should use a data structure that maps familiar `InitSeed` to RNG
+ * objects that are initialized based on the seed from
+ * `EntityPlayer.GetCollectibleRNG(collectibleType)`.
+ *
  * @param player The player that owns the familiars and collectibles.
  * @param collectibleType The collectible type of the collectible associated with this familiar.
  * @param familiarVariant The variant of the familiar to spawn or remove.
  * @param familiarSubType Optional. The sub-type of the familiar to spawn or remove. If not
  * specified, it will search for existing familiars of all sub-types, and spawn new familiars with a
  * sub-type of 0.
- * @returns The amount of familiars that were added or removed. For example, the player has 0
- * collectibles and there were 2 familiars, this function would remove the 2 familiars and return
- * -2.
  */
-export declare function checkFamiliarFromCollectibles(player: EntityPlayer, collectibleType: int, familiarVariant: int, familiarSubType?: int): int;
+export declare function checkFamiliarFromCollectibles(player: EntityPlayer, collectibleType: int, familiarVariant: int, familiarSubType?: int): void;
 export declare function isFamiliarThatShootsPlayerTears(familiar: EntityFamiliar): boolean;

package/dist/functions/familiars.lua

@@ -1,64 +1,29 @@
-local ____lualib = require("lualib_bundle")
-local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____cachedClasses = require("cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
 local ____familiarsThatShootPlayerTearsSet = require("sets.familiarsThatShootPlayerTearsSet")
 local FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET = ____familiarsThatShootPlayerTearsSet.FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET
-local ____array = require("functions.array")
-local copyArray = ____array.copyArray
-local ____entity = require("functions.entity")
-local removeEntities = ____entity.removeEntities
-local ____entitySpecific = require("functions.entitySpecific")
-local getFamiliars = ____entitySpecific.getFamiliars
-local spawnFamiliarWithSeed = ____entitySpecific.spawnFamiliarWithSeed
-local ____utils = require("functions.utils")
-local ____repeat = ____utils["repeat"]
-function ____exports.checkFamiliar(self, player, collectibleType, numTargetFamiliars, familiarVariant, familiarSubType)
-    local familiarSubTypeToSearchFor = familiarSubType == nil and -1 or familiarSubType
-    local playerPtrHash = GetPtrHash(player)
-    local familiars = getFamiliars(nil, familiarVariant, familiarSubTypeToSearchFor)
-    local familiarsForThisPlayer = __TS__ArrayFilter(
-        familiars,
-        function(____, familiar) return GetPtrHash(familiar.Player) == playerPtrHash end
-    )
-    if #familiarsForThisPlayer == numTargetFamiliars then
-        return 0
-    end
-    if #familiarsForThisPlayer > numTargetFamiliars then
-        local numFamiliarsToRemove = #familiarsForThisPlayer - numTargetFamiliars
-        local familiarsToRemove = copyArray(nil, familiarsForThisPlayer, numFamiliarsToRemove)
-        removeEntities(nil, familiarsToRemove)
-        return numFamiliarsToRemove * -1
-    end
-    local numFamiliarsToSpawn = numTargetFamiliars - #familiarsForThisPlayer
-    local collectibleRNG = player:GetCollectibleRNG(collectibleType)
-    local familiarSubTypeToUse = familiarSubType == nil and 0 or familiarSubType
-    ____repeat(
-        nil,
-        numFamiliarsToSpawn,
-        function()
-            local seed = collectibleRNG:Next()
-            local familiar = spawnFamiliarWithSeed(
-                nil,
-                familiarVariant,
-                familiarSubTypeToUse,
-                player.Position,
-                seed
-            )
-            familiar.Player = player
-        end
+function ____exports.checkFamiliar(self, player, collectibleType, targetCount, familiarVariant, familiarSubType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    player:CheckFamiliar(
+        familiarVariant,
+        targetCount,
+        RNG(),
+        itemConfigItem,
+        familiarSubType
     )
-    return numFamiliarsToSpawn
 end
 function ____exports.checkFamiliarFromCollectibles(self, player, collectibleType, familiarVariant, familiarSubType)
     local numCollectibles = player:GetCollectibleNum(collectibleType)
     local effects = player:GetEffects()
     local numCollectibleEffects = effects:GetCollectibleEffectNum(collectibleType)
-    local numTargetFamiliars = numCollectibles + numCollectibleEffects
-    return ____exports.checkFamiliar(
+    local targetCount = numCollectibles + numCollectibleEffects
+    ____exports.checkFamiliar(
         nil,
         player,
         collectibleType,
-        numTargetFamiliars,
+        targetCount,
         familiarVariant,
         familiarSubType
     )

package/dist/functions/utils.d.ts

@@ -92,6 +92,11 @@ export declare function hexToKColor(hexString: string, alpha: float): KColor;
  * is enabled or not.
  */
 export declare function isLuaDebugEnabled(): boolean;
+/**
+ * Since this is a UI element, we do not want to draw it in water reflections. `renderOffset` will
+ * be a non-zero value in reflections.
+ */
+export declare function isReflectionRender(): boolean;
 /**
  * Helper function to print something to the in-game console. Use this instead of invoking the
  * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end

package/dist/functions/utils.lua

@@ -6,6 +6,8 @@ local __TS__StringSubstr = ____lualib.__TS__StringSubstr
 local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
 local ____directionNames = require("objects.directionNames")
 local DIRECTION_NAMES = ____directionNames.DIRECTION_NAMES
 local HEX_STRING_LENGTH = 6
@@ -66,6 +68,11 @@ end
 function ____exports.isLuaDebugEnabled(self)
     return package ~= nil
 end
+function ____exports.isReflectionRender(self)
+    local room = game:GetRoom()
+    local renderMode = room:GetRenderMode()
+    return renderMode == RenderMode.RENDER_WATER_REFLECT
+end
 function ____exports.printConsole(self, msg)
     Isaac.ConsoleOutput(msg .. "\n")
 end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.251",
+  "version": "1.2.254",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.388",
+    "isaac-typescript-definitions": "^1.0.389",
     "isaacscript-lint": "^1.0.99",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",