isaacscript-common 1.2.31 → 1.2.32

package/dist/callbacks/customRevive.lua

@@ -5,8 +5,8 @@ local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____collectibles = require("functions.collectibles")
 local removeCollectibleFromItemTracker = ____collectibles.removeCollectibleFromItemTracker
-local ____entity = require("functions.entity")
-local removeAllFamiliars = ____entity.removeAllFamiliars
+local ____familiars = require("functions.familiars")
+local removeAllFamiliars = ____familiars.removeAllFamiliars
 local ____player = require("functions.player")
 local getPlayerIndex = ____player.getPlayerIndex
 local ____ModCallbacksCustom = require("types.ModCallbacksCustom")

package/dist/functions/entity.d.ts

@@ -85,18 +85,6 @@ export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Ve
  * times.
  */
 export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector>;
-/**
- * Helper function to get all of the familiars in the room.
- *
- * Example:
- * ```
- * // Make all of the familiars in the room invisible
- * for (const familiar of getFamiliars()) {
- *   familiar.Visible = false;
- * }
- * ```
- */
-export declare function getFamiliars(matchingVariant?: FamiliarVariant | int, matchingSubType?: number): EntityFamiliar[];
 /**
  * Helper function to get all of the knives in the room.
  *
@@ -197,15 +185,6 @@ export declare function removeAllBombs(variant?: BombVariant | int, subType?: in
  * @returns True if one or more effects was removed, false otherwise.
  */
 export declare function removeAllEffects(variant?: EffectVariant | int, subType?: int, cap?: int): boolean;
-/**
- * Helper function to remove all of the familiars in the room.
- *
- * @param variant Optional. If specified, will only remove familiars that match this variant.
- * @param subType Optional. If specified, will only remove familiars that match this sub-type.
- * @param cap Optional. If specified, will only remove the given amount of familiars.
- * @returns True if one or more familiars was removed, false otherwise.
- */
-export declare function removeAllFamiliars(variant?: FamiliarVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the knives in the room.
  *

package/dist/functions/entity.lua

@@ -118,23 +118,6 @@ function ____exports.getEntityVelocities(self, entities)
     end
     return entityVelocities
 end
-function ____exports.getFamiliars(self, matchingVariant, matchingSubType)
-    if matchingVariant == nil then
-        matchingVariant = -1
-    end
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    local entities = ____exports.getEntities(nil, EntityType.ENTITY_FAMILIAR, matchingVariant, matchingSubType)
-    local familiars = {}
-    for ____, entity in ipairs(entities) do
-        local familiar = entity:ToFamiliar()
-        if familiar ~= nil then
-            __TS__ArrayPush(familiars, familiar)
-        end
-    end
-    return familiars
-end
 function ____exports.getKnives(self, matchingVariant, matchingSubType)
     if matchingVariant == nil then
         matchingVariant = -1
@@ -266,10 +249,6 @@ function ____exports.removeAllEffects(self, variant, subType, cap)
     local effects = ____exports.getEffects(nil, variant, subType)
     return ____exports.removeEntities(nil, effects, cap)
 end
-function ____exports.removeAllFamiliars(self, variant, subType, cap)
-    local familiars = ____exports.getFamiliars(nil, variant, subType)
-    return ____exports.removeEntities(nil, familiars, cap)
-end
 function ____exports.removeAllKnives(self, variant, subType, cap)
     local knives = ____exports.getKnives(nil, variant, subType)
     return ____exports.removeEntities(nil, knives, cap)

package/dist/functions/familiars.d.ts

@@ -1,2 +1,40 @@
 /// <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`).
+ *
+ * @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;
+/**
+ * Helper function to get all of the familiars in the room.
+ *
+ * Example:
+ * ```
+ * // Make all of the familiars in the room invisible
+ * for (const familiar of getFamiliars()) {
+ *   familiar.Visible = false;
+ * }
+ * ```
+ */
+export declare function getFamiliars(matchingVariant?: FamiliarVariant | int, matchingSubType?: number): EntityFamiliar[];
 export declare function isFamiliarThatShootsPlayerTears(familiar: EntityFamiliar): boolean;
+/**
+ * Helper function to remove all of the familiars in the room.
+ *
+ * @param variant Optional. If specified, will only remove familiars that match this variant.
+ * @param subType Optional. If specified, will only remove familiars that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of familiars.
+ * @returns True if one or more familiars was removed, false otherwise.
+ */
+export declare function removeAllFamiliars(variant?: FamiliarVariant | int, subType?: int, cap?: int): boolean;

package/dist/functions/familiars.lua

@@ -1,10 +1,85 @@
 --[[ 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")
 local FAMILIARS_THAT_SHOOT_PLAYER_TEARS = ____constants.FAMILIARS_THAT_SHOOT_PLAYER_TEARS
+local ____entity = require("functions.entity")
+local getEntities = ____entity.getEntities
+local removeEntities = ____entity.removeEntities
+function ____exports.getFamiliars(self, matchingVariant, matchingSubType)
+    if matchingVariant == nil then
+        matchingVariant = -1
+    end
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    local entities = getEntities(nil, EntityType.ENTITY_FAMILIAR, matchingVariant, matchingSubType)
+    local familiars = {}
+    for ____, entity in ipairs(entities) do
+        local familiar = entity:ToFamiliar()
+        if familiar ~= nil then
+            __TS__ArrayPush(familiars, familiar)
+        end
+    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)
+    if #familiarsForThisPlayer == numCollectibles then
+        return 0
+    end
+    if #familiarsForThisPlayer > numCollectibles then
+        local numFamiliarsToRemove = #familiarsForThisPlayer - numCollectibles
+        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 = numCollectibles - #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,
+                nil,
+                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
+function ____exports.removeAllFamiliars(self, variant, subType, cap)
+    local familiars = ____exports.getFamiliars(nil, variant, subType)
+    return removeEntities(nil, familiars, cap)
+end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.31",
+  "version": "1.2.32",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.0",
-    "isaac-typescript-definitions": "^1.0.343",
+    "isaac-typescript-definitions": "^1.0.347",
     "isaacscript-lint": "^1.0.79",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.12",