isaacscript-common 1.2.33 → 1.2.36

package/dist/functions/familiars.d.ts

@@ -7,15 +7,23 @@
  * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
  * to `CacheFlag.CACHE_FAMILIARS`).
  *
+ * Note that if you want your custom familiar to work properly with Box of Friends, you must keep
+ * track of the number of times that it has been used per room and then pass that as the
+ * `numTempFamiliars` argument.
+ *
  * @param player The player that has the collectibles for this familiar.
  * @param collectibleType The collectible type of the collectible associated with this familiar.
+ * @param numTempFamiliars The amount of extra familiars that should exist that are not associated
+ * with a collectible. Usually, this should be 0. For example, if the player has one familiar and
+ * has used Box of Friends once in the current room, then 1 should be passed (so that 2 total
+ * familiars will be spawned).
  * @param familiarVariant The variant of the familiar to spawn or remove.
  * @param familiarSubType The sub-type of the familiar to spawn
  * @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, familiarVariant: int, familiarSubType?: int): int;
+export declare function checkFamiliar(player: EntityPlayer, collectibleType: int, numTempFamiliars: int, familiarVariant: int, familiarSubType?: int): int;
 /**
  * Helper function to get all of the familiars in the room.
  *

package/dist/functions/familiars.lua

@@ -26,7 +26,7 @@ function ____exports.getFamiliars(self, matchingVariant, matchingSubType)
     end
     return familiars
 end
-function ____exports.checkFamiliar(self, player, collectibleType, familiarVariant, familiarSubType)
+function ____exports.checkFamiliar(self, player, collectibleType, numTempFamiliars, familiarVariant, familiarSubType)
     local game = Game()
     local familiarSubTypeToSearchFor = familiarSubType == nil and -1 or familiarSubType
     local playerPtrHash = GetPtrHash(player)
@@ -36,11 +36,12 @@ function ____exports.checkFamiliar(self, player, collectibleType, familiarVarian
         function(____, familiar) return GetPtrHash(familiar.Player) == playerPtrHash end
     )
     local numCollectibles = player:GetCollectibleNum(collectibleType)
-    if #familiarsForThisPlayer == numCollectibles then
+    local numFamiliarsThatShouldExist = numCollectibles + numTempFamiliars
+    if #familiarsForThisPlayer == numFamiliarsThatShouldExist then
         return 0
     end
-    if #familiarsForThisPlayer > numCollectibles then
-        local numFamiliarsToRemove = #familiarsForThisPlayer - numCollectibles
+    if #familiarsForThisPlayer > numFamiliarsThatShouldExist then
+        local numFamiliarsToRemove = #familiarsForThisPlayer - numFamiliarsThatShouldExist
         do
             local i = 0
             while i < numFamiliarsToRemove do
@@ -51,7 +52,7 @@ function ____exports.checkFamiliar(self, player, collectibleType, familiarVarian
         end
         return numFamiliarsToRemove * -1
     end
-    local numFamiliarsToSpawn = numCollectibles - #familiarsForThisPlayer
+    local numFamiliarsToSpawn = numFamiliarsThatShouldExist - #familiarsForThisPlayer
     local collectibleRNG = player:GetCollectibleRNG(collectibleType)
     local familiarSubTypeToUse = familiarSubType == nil and 0 or familiarSubType
     do

package/package.json

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