isaacscript-common 1.2.38 → 1.2.39

package/dist/functions/familiars.d.ts

@@ -1,4 +1,21 @@
 /// <reference types="isaac-typescript-definitions" />
+/**
+ * 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 functions correctly.
+ *
+ * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
+ * to `CacheFlag.CACHE_FAMILIARS`).
+ *
+ * @param player The player that has the collectibles for this familiar.
+ * @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. 0 by default.
+ * @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;
 /**
  * Helper function to get all of the familiars in the room.
  *

package/dist/functions/familiars.lua

@@ -1,6 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
 local ____constants = require("constants")
@@ -25,6 +26,58 @@ function ____exports.getFamiliars(self, matchingVariant, matchingSubType)
     end
     return familiars
 end
+function ____exports.checkFamiliar(self, player, collectibleType, familiarVariant, familiarSubType)
+    local game = Game()
+    local familiarSubTypeToSearchFor = familiarSubType == nil and -1 or familiarSubType
+    local playerPtrHash = GetPtrHash(player)
+    local familiars = ____exports.getFamiliars(nil, familiarVariant, familiarSubTypeToSearchFor)
+    local familiarsForThisPlayer = __TS__ArrayFilter(
+        familiars,
+        function(____, familiar) return GetPtrHash(familiar.Player) == playerPtrHash end
+    )
+    local numCollectibles = player:GetCollectibleNum(collectibleType)
+    local effects = player:GetEffects()
+    local numBoxOfFriendsUses = effects:GetCollectibleEffectNum(CollectibleType.COLLECTIBLE_BOX_OF_FRIENDS)
+    local numFamiliarsThatShouldExist = numCollectibles * (numBoxOfFriendsUses + 1)
+    if #familiarsForThisPlayer == numFamiliarsThatShouldExist then
+        return 0
+    end
+    if #familiarsForThisPlayer > numFamiliarsThatShouldExist then
+        local numFamiliarsToRemove = #familiarsForThisPlayer - numFamiliarsThatShouldExist
+        do
+            local i = 0
+            while i < numFamiliarsToRemove do
+                local familiar = familiarsForThisPlayer[i + 1]
+                familiar:Remove()
+                i = i + 1
+            end
+        end
+        return numFamiliarsToRemove * -1
+    end
+    local numFamiliarsToSpawn = numFamiliarsThatShouldExist - #familiarsForThisPlayer
+    local collectibleRNG = player:GetCollectibleRNG(collectibleType)
+    local familiarSubTypeToUse = familiarSubType == nil and 0 or familiarSubType
+    do
+        local i = 0
+        while i < numFamiliarsToSpawn do
+            collectibleRNG:Next()
+            local familiar = game:Spawn(
+                EntityType.ENTITY_FAMILIAR,
+                familiarVariant,
+                player.Position,
+                Vector.Zero,
+                player,
+                familiarSubTypeToUse,
+                collectibleRNG:GetSeed()
+            ):ToFamiliar()
+            if familiar ~= nil then
+                familiar.Player = player
+            end
+            i = i + 1
+        end
+    end
+    return numFamiliarsToSpawn
+end
 function ____exports.isFamiliarThatShootsPlayerTears(self, familiar)
     return FAMILIARS_THAT_SHOOT_PLAYER_TEARS:has(familiar.Type)
 end

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 export { forceNewLevelCallback, forceNewRoomCallback, } from "./callbacks/reorderedCallbacks";
 export * from "./constants";
-export * from "./features/checkFamiliar";
 export { deployJSONRoom, deployRandomJSONRoom, emptyRoom, } from "./features/deployJSONRoom";
 export { disableAllInputs, disableAllInputsExceptFor, disableMovementInputs, disableShootingInputs, enableAllInputs, enableAllInputsExceptFor, } from "./features/disableInputs";
 export { forgottenSwitch } from "./features/forgottenSwitch";

package/dist/index.lua

@@ -15,14 +15,6 @@ do
         end
     end
 end
-do
-    local ____export = require("features.checkFamiliar")
-    for ____exportKey, ____exportValue in pairs(____export) do
-        if ____exportKey ~= "default" then
-            ____exports[____exportKey] = ____exportValue
-        end
-    end
-end
 do
     local ____deployJSONRoom = require("features.deployJSONRoom")
     local deployJSONRoom = ____deployJSONRoom.deployJSONRoom

package/dist/upgradeMod.lua

@@ -69,8 +69,6 @@ local ____preNewLevel = require("callbacks.preNewLevel")
 local preNewLevelCallbackInit = ____preNewLevel.preNewLevelCallbackInit
 local ____reorderedCallbacks = require("callbacks.reorderedCallbacks")
 local reorderedCallbacksInit = ____reorderedCallbacks.reorderedCallbacksInit
-local ____checkFamiliar = require("features.checkFamiliar")
-local checkFamiliarInit = ____checkFamiliar.checkFamiliarInit
 local ____deployJSONRoom = require("features.deployJSONRoom")
 local deployJSONRoomInit = ____deployJSONRoom.deployJSONRoomInit
 local ____disableInputs = require("features.disableInputs")
@@ -129,7 +127,6 @@ function initCustomCallbacks(self, mod)
     postGridEntityCollisionInit(nil, mod)
 end
 function initFeatures(self, mod)
-    checkFamiliarInit(nil, mod)
     deployJSONRoomInit(nil, mod)
     disableInputsInit(nil, mod)
     forgottenSwitchInit(nil, mod)

package/package.json

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