isaacscript-common 1.2.36 → 1.2.37

package/dist/features/checkFamiliar.d.ts

@@ -0,0 +1,18 @@
+/// <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 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;

package/dist/features/checkFamiliar.lua

@@ -0,0 +1,78 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local useItemBoxOfFriends, v
+local ____errors = require("errors")
+local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
+local ____familiars = require("functions.familiars")
+local getFamiliars = ____familiars.getFamiliars
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function useItemBoxOfFriends(self)
+    local ____v_room_0, ____numBoxOfFriendsUses_1 = v.room, "numBoxOfFriendsUses"
+    ____v_room_0[____numBoxOfFriendsUses_1] = ____v_room_0[____numBoxOfFriendsUses_1] + 1
+end
+local FEATURE_NAME = "check familiar"
+local initialized = false
+v = {room = {numBoxOfFriendsUses = 0}}
+function ____exports.checkFamiliarInit(self, mod)
+    initialized = true
+    saveDataManager(nil, "checkFamiliar", v)
+    mod:AddCallback(ModCallbacks.MC_USE_ITEM, useItemBoxOfFriends, CollectibleType.COLLECTIBLE_BOX_OF_FRIENDS)
+end
+function ____exports.checkFamiliar(self, player, collectibleType, familiarVariant, familiarSubType)
+    if not initialized then
+        local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
+        error(msg)
+    end
+    local game = Game()
+    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
+    )
+    local numCollectibles = player:GetCollectibleNum(collectibleType)
+    local numFamiliarsThatShouldExist = numCollectibles * (v.room.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
+return ____exports

package/dist/functions/familiars.d.ts

@@ -1,29 +1,4 @@
 /// <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.
- *
- * 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, numTempFamiliars: int, familiarVariant: int, familiarSubType?: int): int;
 /**
  * Helper function to get all of the familiars in the room.
  *

package/dist/functions/familiars.lua

@@ -1,7 +1,6 @@
 --[[ 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")
@@ -26,56 +25,6 @@ function ____exports.getFamiliars(self, matchingVariant, matchingSubType)
     end
     return familiars
 end
-function ____exports.checkFamiliar(self, player, collectibleType, numTempFamiliars, 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 numFamiliarsThatShouldExist = numCollectibles + numTempFamiliars
-    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/upgradeMod.lua

@@ -69,6 +69,8 @@ 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")
@@ -127,6 +129,7 @@ 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.36",
+  "version": "1.2.37",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",