isaacscript-common 11.2.3 → 11.2.4

package/dist/index.d.ts

@@ -2627,6 +2627,16 @@ export declare function getCharacterName(character: PlayerType): string;
 /** Helper function to get an array containing the characters of all of the current players. */
 export declare function getCharacters(): PlayerType[];
 
+/**
+ * Helper function to get the amount of charges away from the maximum charge that a particular
+ * player is.
+ *
+ * This function accounts for The Battery. For example, if the player has 2/6 charges on a D6, this
+ * function will return 10 (because there are 4 charges remaining on the base charge and 6 charges
+ * remaining on The Battery charge).
+ */
+export declare function getChargesAwayFromMax(player: EntityPlayer, activeSlot: ActiveSlot): int;
+
 /**
  * Helper function to get an array of equidistant points on the circumference around a circle.
  * Useful for equally distributing things in a circle pattern.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 11.2.3
+isaacscript-common 11.2.4
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -27608,7 +27608,7 @@ return ____exports
  end,
 ["src.functions.charge"] = function(...) 
 local ____exports = {}
-local getClampedChargesToAdd, getChargesToAddWithAAAModifier, shouldPlayFullRechargeSound
+local getChargesToAddWithAAAModifier, shouldPlayFullRechargeSound
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
@@ -27650,7 +27650,8 @@ function ____exports.addCharge(self, player, activeSlot, numCharges, playSoundEf
         playSoundEffect = true
     end
     local hud = game:GetHUD()
-    local chargesToAdd = getClampedChargesToAdd(nil, player, activeSlot, numCharges)
+    local chargesAwayFromMax = ____exports.getChargesAwayFromMax(nil, player, activeSlot)
+    local chargesToAdd = numCharges > chargesAwayFromMax and chargesAwayFromMax or numCharges
     local modifiedChargesToAdd = getChargesToAddWithAAAModifier(nil, player, activeSlot, chargesToAdd)
     local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
     local newCharge = totalCharge + modifiedChargesToAdd
@@ -27697,6 +27698,9 @@ function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, bigRoomD
     local room = game:GetRoom()
     local roomShape = room:GetRoomShape()
     local numCharges = bigRoomDoubleCharge and getRoomShapeCharges(nil, roomShape) or 1
+    if chargeType == ItemConfigChargeType.TIMED then
+        numCharges = getCollectibleMaxCharges(nil, activeItem)
+    end
     ____exports.addCharge(
         nil,
         player,
@@ -27705,43 +27709,28 @@ function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, bigRoomD
         playSoundEffect
     )
 end
-function getClampedChargesToAdd(self, player, activeSlot, numCharges)
-    local activeItem = player:GetActiveItem(activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
-    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
-    if not hasBattery and activeCharge == maxCharges then
-        return 0
-    end
-    if hasBattery and batteryCharge == maxCharges then
-        return 0
-    end
-    if not hasBattery and activeCharge + 1 == maxCharges then
-        return 1
-    end
-    if hasBattery and batteryCharge + 1 == maxCharges then
-        return 1
-    end
-    return numCharges
-end
 function getChargesToAddWithAAAModifier(self, player, activeSlot, chargesToAdd)
-    local activeItem = player:GetActiveItem(activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
     local hasAAABattery = player:HasTrinket(TrinketType.AAA_BATTERY)
-    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
     if not hasAAABattery then
         return chargesToAdd
     end
-    if not hasBattery and activeCharge + chargesToAdd == maxCharges - 1 then
-        return chargesToAdd + 1
-    end
-    if hasBattery and batteryCharge + chargesToAdd == maxCharges - 1 then
-        return chargesToAdd + 1
-    end
-    return chargesToAdd
+    local chargesAwayFromMax = ____exports.getChargesAwayFromMax(nil, player, activeSlot)
+    local AAABatteryShouldApply = chargesToAdd == chargesAwayFromMax - 1
+    return AAABatteryShouldApply and chargesToAdd + 1 or chargesToAdd
+end
+--- Helper function to get the amount of charges away from the maximum charge that a particular
+-- player is.
+-- 
+-- This function accounts for The Battery. For example, if the player has 2/6 charges on a D6, this
+-- function will return 10 (because there are 4 charges remaining on the base charge and 6 charges
+-- remaining on The Battery charge).
+function ____exports.getChargesAwayFromMax(self, player, activeSlot)
+    local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
+    local activeItem = player:GetActiveItem(activeSlot)
+    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
+    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
+    local effectiveMaxCharges = hasBattery and maxCharges * 2 or maxCharges
+    return effectiveMaxCharges - totalCharge
 end
 --- Helper function to get the combined normal charge and the battery charge for the player's active
 -- item. This is useful because you have to add these two values together when setting the active
@@ -46970,7 +46959,7 @@ return ____exports
 ["package"] = function(...) 
 return {
     name = "isaacscript-common",
-    version = "11.2.3",
+    version = "11.2.4",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",

package/dist/package.lua

@@ -1,6 +1,6 @@
 return {
     name = "isaacscript-common",
-    version = "11.2.3",
+    version = "11.2.4",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",

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

@@ -68,6 +68,15 @@ export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlo
  *                            is true.
  */
 export declare function addRoomClearCharges(bigRoomDoubleCharge?: boolean): void;
+/**
+ * Helper function to get the amount of charges away from the maximum charge that a particular
+ * player is.
+ *
+ * This function accounts for The Battery. For example, if the player has 2/6 charges on a D6, this
+ * function will return 10 (because there are 4 charges remaining on the base charge and 6 charges
+ * remaining on The Battery charge).
+ */
+export declare function getChargesAwayFromMax(player: EntityPlayer, activeSlot: ActiveSlot): int;
 /**
  * Helper function to get the combined normal charge and the battery charge for the player's active
  * item. This is useful because you have to add these two values together when setting the active

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,EAAE,UAAU,EACtB,UAAU,SAAI,EACd,eAAe,UAAO,GACrB,GAAG,CA2BL;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,EACpB,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CAaN;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,EACtB,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CAkBN;AAuED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,mBAAmB,UAAO,GAAG,IAAI,CAIpE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAKL;AAED,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,OAAO,CAMT;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,IAAI,CAYN"}
+{"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,EAAE,UAAU,EACtB,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;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,EACtB,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CA4BN;AAqBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,mBAAmB,UAAO,GAAG,IAAI,CAIpE;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAQL;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAKL;AAED,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,OAAO,CAMT;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,IAAI,CAYN"}

package/dist/src/functions/charge.lua

@@ -1,5 +1,5 @@
 local ____exports = {}
-local getClampedChargesToAdd, getChargesToAddWithAAAModifier, shouldPlayFullRechargeSound
+local getChargesToAddWithAAAModifier, shouldPlayFullRechargeSound
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
@@ -41,7 +41,8 @@ function ____exports.addCharge(self, player, activeSlot, numCharges, playSoundEf
         playSoundEffect = true
     end
     local hud = game:GetHUD()
-    local chargesToAdd = getClampedChargesToAdd(nil, player, activeSlot, numCharges)
+    local chargesAwayFromMax = ____exports.getChargesAwayFromMax(nil, player, activeSlot)
+    local chargesToAdd = numCharges > chargesAwayFromMax and chargesAwayFromMax or numCharges
     local modifiedChargesToAdd = getChargesToAddWithAAAModifier(nil, player, activeSlot, chargesToAdd)
     local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
     local newCharge = totalCharge + modifiedChargesToAdd
@@ -88,6 +89,9 @@ function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, bigRoomD
     local room = game:GetRoom()
     local roomShape = room:GetRoomShape()
     local numCharges = bigRoomDoubleCharge and getRoomShapeCharges(nil, roomShape) or 1
+    if chargeType == ItemConfigChargeType.TIMED then
+        numCharges = getCollectibleMaxCharges(nil, activeItem)
+    end
     ____exports.addCharge(
         nil,
         player,
@@ -96,43 +100,28 @@ function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, bigRoomD
         playSoundEffect
     )
 end
-function getClampedChargesToAdd(self, player, activeSlot, numCharges)
-    local activeItem = player:GetActiveItem(activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
-    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
-    if not hasBattery and activeCharge == maxCharges then
-        return 0
-    end
-    if hasBattery and batteryCharge == maxCharges then
-        return 0
-    end
-    if not hasBattery and activeCharge + 1 == maxCharges then
-        return 1
-    end
-    if hasBattery and batteryCharge + 1 == maxCharges then
-        return 1
-    end
-    return numCharges
-end
 function getChargesToAddWithAAAModifier(self, player, activeSlot, chargesToAdd)
-    local activeItem = player:GetActiveItem(activeSlot)
-    local activeCharge = player:GetActiveCharge(activeSlot)
-    local batteryCharge = player:GetBatteryCharge(activeSlot)
-    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
     local hasAAABattery = player:HasTrinket(TrinketType.AAA_BATTERY)
-    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
     if not hasAAABattery then
         return chargesToAdd
     end
-    if not hasBattery and activeCharge + chargesToAdd == maxCharges - 1 then
-        return chargesToAdd + 1
-    end
-    if hasBattery and batteryCharge + chargesToAdd == maxCharges - 1 then
-        return chargesToAdd + 1
-    end
-    return chargesToAdd
+    local chargesAwayFromMax = ____exports.getChargesAwayFromMax(nil, player, activeSlot)
+    local AAABatteryShouldApply = chargesToAdd == chargesAwayFromMax - 1
+    return AAABatteryShouldApply and chargesToAdd + 1 or chargesToAdd
+end
+--- Helper function to get the amount of charges away from the maximum charge that a particular
+-- player is.
+-- 
+-- This function accounts for The Battery. For example, if the player has 2/6 charges on a D6, this
+-- function will return 10 (because there are 4 charges remaining on the base charge and 6 charges
+-- remaining on The Battery charge).
+function ____exports.getChargesAwayFromMax(self, player, activeSlot)
+    local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
+    local activeItem = player:GetActiveItem(activeSlot)
+    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
+    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
+    local effectiveMaxCharges = hasBattery and maxCharges * 2 or maxCharges
+    return effectiveMaxCharges - totalCharge
 end
 --- Helper function to get the combined normal charge and the battery charge for the player's active
 -- item. This is useful because you have to add these two values together when setting the active

package/package.json

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

package/src/functions/charge.ts

@@ -40,8 +40,12 @@ export function addCharge(
 ): int {
   const hud = game.GetHUD();
 
-  // Ensure that there is enough space on the active item to store these amount of charges.
-  const chargesToAdd = getClampedChargesToAdd(player, activeSlot, numCharges);
+  // Ensure that there is enough space on the active item to store these amount of charges. (If we
+  // add too many charges, it will grant orange "battery" charges, even if the player does not have
+  // The Battery.)
+  const chargesAwayFromMax = getChargesAwayFromMax(player, activeSlot);
+  const chargesToAdd =
+    numCharges > chargesAwayFromMax ? chargesAwayFromMax : numCharges;
 
   // The AAA Battery trinket might grant an additional charge.
   const modifiedChargesToAdd = getChargesToAddWithAAAModifier(
@@ -139,46 +143,18 @@ export function addRoomClearChargeToSlot(
   const room = game.GetRoom();
   const roomShape = room.GetRoomShape();
 
-  const numCharges = bigRoomDoubleCharge ? getRoomShapeCharges(roomShape) : 1;
-  addCharge(player, activeSlot, numCharges, playSoundEffect);
-}
+  // Big rooms grant two charges and normal rooms grant one charge.
+  let numCharges = bigRoomDoubleCharge ? getRoomShapeCharges(roomShape) : 1;
 
-/**
- * We don't want to add more charges than is normally possible, so we must check to see if the
- * player can hold the specified amount of charges in the given slot.
- */
-function getClampedChargesToAdd(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-  numCharges: int,
-) {
-  const activeItem = player.GetActiveItem(activeSlot);
-  const activeCharge = player.GetActiveCharge(activeSlot);
-  const batteryCharge = player.GetBatteryCharge(activeSlot);
-  const hasBattery = player.HasCollectible(CollectibleType.BATTERY);
-  const maxCharges = getCollectibleMaxCharges(activeItem);
-
-  if (!hasBattery && activeCharge === maxCharges) {
-    return 0;
-  }
-
-  if (hasBattery && batteryCharge === maxCharges) {
-    return 0;
+  // Handle the special case of a timed item. When clearing a room with a timed item, it should
+  // become fully charged.
+  if (chargeType === ItemConfigChargeType.TIMED) {
+    // The charges will become clamped to the proper amount in the `addCharge` function. (If the
+    // item is at 50% charge and the player has The Battery, it should go to 150% charged.)
+    numCharges = getCollectibleMaxCharges(activeItem);
   }
 
-  if (!hasBattery && activeCharge + 1 === maxCharges) {
-    // We are only 1 charge away from a full charge, so only add one charge to avoid an overcharge.
-    // (It is possible to set orange charges without the player actually having The Battery.)
-    return 1;
-  }
-
-  if (hasBattery && batteryCharge + 1 === maxCharges) {
-    // We are only 1 charge away from a full double-charge, so only add one charge to avoid an
-    // overcharge.
-    return 1;
-  }
-
-  return numCharges;
+  addCharge(player, activeSlot, numCharges, playSoundEffect);
 }
 
 /**
@@ -190,26 +166,14 @@ function getChargesToAddWithAAAModifier(
   activeSlot: ActiveSlot,
   chargesToAdd: int,
 ) {
-  const activeItem = player.GetActiveItem(activeSlot);
-  const activeCharge = player.GetActiveCharge(activeSlot);
-  const batteryCharge = player.GetBatteryCharge(activeSlot);
-  const hasBattery = player.HasCollectible(CollectibleType.BATTERY);
   const hasAAABattery = player.HasTrinket(TrinketType.AAA_BATTERY);
-  const maxCharges = getCollectibleMaxCharges(activeItem);
-
   if (!hasAAABattery) {
     return chargesToAdd;
   }
 
-  if (!hasBattery && activeCharge + chargesToAdd === maxCharges - 1) {
-    return chargesToAdd + 1;
-  }
-
-  if (hasBattery && batteryCharge + chargesToAdd === maxCharges - 1) {
-    return chargesToAdd + 1;
-  }
-
-  return chargesToAdd;
+  const chargesAwayFromMax = getChargesAwayFromMax(player, activeSlot);
+  const AAABatteryShouldApply = chargesToAdd === chargesAwayFromMax - 1;
+  return AAABatteryShouldApply ? chargesToAdd + 1 : chargesToAdd;
 }
 
 /**
@@ -231,6 +195,27 @@ export function addRoomClearCharges(bigRoomDoubleCharge = true): void {
   }
 }
 
+/**
+ * Helper function to get the amount of charges away from the maximum charge that a particular
+ * player is.
+ *
+ * This function accounts for The Battery. For example, if the player has 2/6 charges on a D6, this
+ * function will return 10 (because there are 4 charges remaining on the base charge and 6 charges
+ * remaining on The Battery charge).
+ */
+export function getChargesAwayFromMax(
+  player: EntityPlayer,
+  activeSlot: ActiveSlot,
+): int {
+  const totalCharge = getTotalCharge(player, activeSlot);
+  const activeItem = player.GetActiveItem(activeSlot);
+  const hasBattery = player.HasCollectible(CollectibleType.BATTERY);
+  const maxCharges = getCollectibleMaxCharges(activeItem);
+  const effectiveMaxCharges = hasBattery ? maxCharges * 2 : maxCharges;
+
+  return effectiveMaxCharges - totalCharge;
+}
+
 /**
  * Helper function to get the combined normal charge and the battery charge for the player's active
  * item. This is useful because you have to add these two values together when setting the active