isaacscript-common 29.7.0 → 29.8.0

package/dist/index.rollup.d.ts

@@ -6915,6 +6915,13 @@ export declare function getTSTLClassName(object: unknown): string | undefined;
  */
 export declare function getUnusedDoorSlots(): DoorSlot[];
 
+/**
+ * Helper function to find the active slots that the player has the corresponding collectible type
+ * in and have enough charge to be used. Returns an empty array if the player does not have the
+ * collectible in any active slot or does not have enough charges.
+ */
+export declare function getUsableActiveItemSlots(player: EntityPlayer, collectibleType: CollectibleType): ActiveSlot[];
+
 /**
  * Helper function to get an array with every valid vanilla card sub-type.
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 29.7.0
+isaacscript-common 29.8.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -25339,6 +25339,8 @@ end
 return ____exports
  end,
 ["src.functions.charge"] = function(...) 
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local getChargesToAddWithAAAModifier, shouldPlayFullRechargeSound
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
@@ -25355,6 +25357,8 @@ local getCollectibleChargeType = ____collectibles.getCollectibleChargeType
 local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
 local ____playerIndex = require("src.functions.playerIndex")
 local getPlayers = ____playerIndex.getPlayers
+local ____players = require("src.functions.players")
+local getActiveItemSlots = ____players.getActiveItemSlots
 local ____roomShape = require("src.functions.roomShape")
 local getRoomShapeCharges = ____roomShape.getRoomShapeCharges
 function ____exports.addCharge(self, player, activeSlot, numCharges, playSoundEffect)
@@ -25489,6 +25493,17 @@ function ____exports.addRoomClearCharges(self, bigRoomDoubleCharge)
         ____exports.addRoomClearCharge(nil, player, bigRoomDoubleCharge)
     end
 end
+function ____exports.getUsableActiveItemSlots(self, player, collectibleType)
+    local maxCharges = getCollectibleMaxCharges(nil, collectibleType)
+    local activeSlots = getActiveItemSlots(nil, player, collectibleType)
+    return __TS__ArrayFilter(
+        activeSlots,
+        function(____, activeSlot)
+            local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
+            return totalCharge >= maxCharges
+        end
+    )
+end
 function ____exports.isActiveSlotDoubleCharged(self, player, activeSlot)
     if activeSlot == nil then
         activeSlot = ActiveSlot.PRIMARY

package/dist/src/functions/charge.d.ts

@@ -1,4 +1,4 @@
-import { ActiveSlot } from "isaac-typescript-definitions";
+import { ActiveSlot, CollectibleType } from "isaac-typescript-definitions";
 /**
  * Helper function to add a charge to the player's active item. Will flash the HUD and play the
  * appropriate sound effect, depending on whether the charge is partially full or completely full.
@@ -90,6 +90,12 @@ export declare function getChargesAwayFromMax(player: EntityPlayer, activeSlot?:
  * @param activeSlot Optional. The slot to get the charges from. Default is `ActiveSlot.PRIMARY`.
  */
 export declare function getTotalCharge(player: EntityPlayer, activeSlot?: ActiveSlot): int;
+/**
+ * Helper function to find the active slots that the player has the corresponding collectible type
+ * in and have enough charge to be used. Returns an empty array if the player does not have the
+ * collectible in any active slot or does not have enough charges.
+ */
+export declare function getUsableActiveItemSlots(player: EntityPlayer, collectibleType: CollectibleType): ActiveSlot[];
 /**
  * Helper function to check if a player's active item is "double charged", meaning that it has both
  * a full normal charge and a full charge from The Battery.

package/dist/src/functions/charge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"charge.d.ts","sourceRoot":"","sources":["../../../src/functions/charge.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAKX,MAAM,8BAA8B,CAAC;AAStC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,EAC/B,UAAU,SAAI,EACd,eAAe,UAAO,GACrB,GAAG,CA+BL;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,EACpB,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CAaN;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,EAC/B,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CA4BN;AAqBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,mBAAmB,UAAO,GAAG,IAAI,CAIpE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,GAAG,CAQL;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,GAAG,CAKL;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,OAAO,CAMT;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,IAAI,CAYN"}
+{"version":3,"file":"charge.d.ts","sourceRoot":"","sources":["../../../src/functions/charge.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,eAAe,EAIhB,MAAM,8BAA8B,CAAC;AAUtC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,EAC/B,UAAU,SAAI,EACd,eAAe,UAAO,GACrB,GAAG,CA+BL;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,EACpB,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CAaN;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,EAC/B,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CA4BN;AAqBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,mBAAmB,UAAO,GAAG,IAAI,CAIpE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,GAAG,CAQL;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,GAAG,CAKL;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,UAAU,EAAE,CAOd;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,OAAO,CAMT;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,UAAU,aAAqB,GAC9B,IAAI,CAYN"}

package/dist/src/functions/charge.lua

@@ -1,3 +1,5 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local getChargesToAddWithAAAModifier, shouldPlayFullRechargeSound
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
@@ -14,6 +16,8 @@ local getCollectibleChargeType = ____collectibles.getCollectibleChargeType
 local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
 local ____playerIndex = require("src.functions.playerIndex")
 local getPlayers = ____playerIndex.getPlayers
+local ____players = require("src.functions.players")
+local getActiveItemSlots = ____players.getActiveItemSlots
 local ____roomShape = require("src.functions.roomShape")
 local getRoomShapeCharges = ____roomShape.getRoomShapeCharges
 --- Helper function to add a charge to the player's active item. Will flash the HUD and play the
@@ -227,6 +231,20 @@ function ____exports.addRoomClearCharges(self, bigRoomDoubleCharge)
         ____exports.addRoomClearCharge(nil, player, bigRoomDoubleCharge)
     end
 end
+--- Helper function to find the active slots that the player has the corresponding collectible type
+-- in and have enough charge to be used. Returns an empty array if the player does not have the
+-- collectible in any active slot or does not have enough charges.
+function ____exports.getUsableActiveItemSlots(self, player, collectibleType)
+    local maxCharges = getCollectibleMaxCharges(nil, collectibleType)
+    local activeSlots = getActiveItemSlots(nil, player, collectibleType)
+    return __TS__ArrayFilter(
+        activeSlots,
+        function(____, activeSlot)
+            local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
+            return totalCharge >= maxCharges
+        end
+    )
+end
 --- Helper function to check if a player's active item is "double charged", meaning that it has both
 -- a full normal charge and a full charge from The Battery.
 -- 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "29.7.0",
+  "version": "29.8.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/charge.ts

@@ -11,6 +11,7 @@ import {
   getCollectibleMaxCharges,
 } from "./collectibles";
 import { getPlayers } from "./playerIndex";
+import { getActiveItemSlots } from "./players";
 import { getRoomShapeCharges } from "./roomShape";
 
 /**
@@ -238,6 +239,23 @@ export function getTotalCharge(
   return activeCharge + batteryCharge;
 }
 
+/**
+ * Helper function to find the active slots that the player has the corresponding collectible type
+ * in and have enough charge to be used. Returns an empty array if the player does not have the
+ * collectible in any active slot or does not have enough charges.
+ */
+export function getUsableActiveItemSlots(
+  player: EntityPlayer,
+  collectibleType: CollectibleType,
+): ActiveSlot[] {
+  const maxCharges = getCollectibleMaxCharges(collectibleType);
+  const activeSlots = getActiveItemSlots(player, collectibleType);
+  return activeSlots.filter((activeSlot) => {
+    const totalCharge = getTotalCharge(player, activeSlot);
+    return totalCharge >= maxCharges;
+  });
+}
+
 /**
  * Helper function to check if a player's active item is "double charged", meaning that it has both
  * a full normal charge and a full charge from The Battery.