isaacscript-common 5.0.0 → 5.0.1

package/functions/charge.d.ts

@@ -1,7 +1,10 @@
 import { ActiveSlot } from "isaac-typescript-definitions";
 /**
- * Helper function to add a charge to the player's active item. Will play the appropriate sound
- * effect, depending on whether the charge is partially full or completely full.
+ * 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.
+ *
+ * If the player's active item is already fully charged, then this function will return 0 and not
+ * flash the HUD or play a sound effect.
  *
  * This function will take the following things into account:
  * - The Battery
@@ -12,7 +15,8 @@ import { ActiveSlot } from "isaac-typescript-definitions";
  * @param numCharges Optional. The amount of charges to grant. Default is 1.
  * @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
  * @returns The amount of charges that were actually granted. For example, if the active item was
- *          already fully charged, this function would return 0.
+ *          only one away from a full charge, but the `numCharges` provided to this function was 2,
+ *          then this function would return 1.
  */
 export declare function addCharge(player: EntityPlayer, activeSlot: ActiveSlot, numCharges?: number, playSoundEffect?: boolean): int;
 /**

package/functions/charge.lua

@@ -14,8 +14,11 @@ local ____playerIndex = require("functions.playerIndex")
 local getPlayers = ____playerIndex.getPlayers
 local ____roomShape = require("functions.roomShape")
 local getRoomShapeCharges = ____roomShape.getRoomShapeCharges
---- Helper function to add a charge to the player's active item. Will play the appropriate sound
--- effect, depending on whether the charge is partially full or completely full.
+--- 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.
+-- 
+-- If the player's active item is already fully charged, then this function will return 0 and not
+-- flash the HUD or play a sound effect.
 -- 
 -- This function will take the following things into account:
 -- - The Battery
@@ -26,7 +29,8 @@ local getRoomShapeCharges = ____roomShape.getRoomShapeCharges
 -- @param numCharges Optional. The amount of charges to grant. Default is 1.
 -- @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
 -- @returns The amount of charges that were actually granted. For example, if the active item was
--- already fully charged, this function would return 0.
+-- only one away from a full charge, but the `numCharges` provided to this function was 2,
+-- then this function would return 1.
 function ____exports.addCharge(self, player, activeSlot, numCharges, playSoundEffect)
     if numCharges == nil then
         numCharges = 1
@@ -35,9 +39,9 @@ function ____exports.addCharge(self, player, activeSlot, numCharges, playSoundEf
         playSoundEffect = true
     end
     local hud = game:GetHUD()
-    local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
     local chargesToAdd = getClampedChargesToAdd(nil, player, activeSlot, numCharges)
     local modifiedChargesToAdd = getNumChargesWithAAAModifier(nil, player, activeSlot, chargesToAdd)
+    local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
     local newCharge = totalCharge + modifiedChargesToAdd
     if newCharge == totalCharge then
         return 0
@@ -112,10 +116,10 @@ function getNumChargesWithAAAModifier(self, player, activeSlot, chargesToAdd)
         return chargesToAdd
     end
     if not hasBattery and activeCharge + chargesToAdd == maxCharges - 1 then
-        return maxCharges + 1
+        return chargesToAdd + 1
     end
     if hasBattery and batteryCharge + chargesToAdd == maxCharges - 1 then
-        return maxCharges + 1
+        return chargesToAdd + 1
     end
     return chargesToAdd
 end

package/objects/roomShapeToDoorSlotCoordinates.d.ts

@@ -0,0 +1,4 @@
+import { DoorSlot, RoomShape } from "isaac-typescript-definitions";
+export declare const ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES: {
+    readonly [key in RoomShape]: ReadonlySet<DoorSlot>;
+};

package/objects/roomShapeToDoorSlotCoordinates.lua

@@ -0,0 +1,46 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
+local ALL_DOOR_SLOTS_SET = __TS__New(Set, {
+    DoorSlot.LEFT_0,
+    DoorSlot.UP_0,
+    DoorSlot.RIGHT_0,
+    DoorSlot.DOWN_0,
+    DoorSlot.LEFT_1,
+    DoorSlot.UP_1,
+    DoorSlot.RIGHT_1,
+    DoorSlot.DOWN_1
+})
+____exports.ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES = {
+    [RoomShape.SHAPE_1x1] = __TS__New(Set, {DoorSlot.LEFT_0, DoorSlot.UP_0, DoorSlot.RIGHT_0, DoorSlot.DOWN_0}),
+    [RoomShape.IH] = __TS__New(Set, {DoorSlot.LEFT_0, DoorSlot.RIGHT_0}),
+    [RoomShape.IV] = __TS__New(Set, {DoorSlot.UP_0, DoorSlot.DOWN_0}),
+    [RoomShape.SHAPE_1x2] = __TS__New(Set, {
+        DoorSlot.LEFT_0,
+        DoorSlot.UP_0,
+        DoorSlot.RIGHT_0,
+        DoorSlot.DOWN_0,
+        DoorSlot.LEFT_1,
+        DoorSlot.RIGHT_1
+    }),
+    [RoomShape.IIV] = __TS__New(Set, {DoorSlot.UP_0, DoorSlot.DOWN_0}),
+    [RoomShape.SHAPE_2x1] = __TS__New(Set, {
+        DoorSlot.LEFT_0,
+        DoorSlot.UP_0,
+        DoorSlot.RIGHT_0,
+        DoorSlot.DOWN_0,
+        DoorSlot.UP_1,
+        DoorSlot.DOWN_1
+    }),
+    [RoomShape.IIH] = __TS__New(Set, {DoorSlot.LEFT_0, DoorSlot.RIGHT_0}),
+    [RoomShape.SHAPE_2x2] = ALL_DOOR_SLOTS_SET,
+    [RoomShape.LTL] = ALL_DOOR_SLOTS_SET,
+    [RoomShape.LTR] = ALL_DOOR_SLOTS_SET,
+    [RoomShape.LBL] = ALL_DOOR_SLOTS_SET,
+    [RoomShape.LBR] = ALL_DOOR_SLOTS_SET
+}
+return ____exports

package/package.json

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