isaacscript-common 1.0.485 → 1.0.486

package/dist/functions/player.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
 import { HealthType } from "../types/HealthType";
-import { PocketItemDescription } from "../types/PocketItemDescription";
 /**
  * PlayerIndex is a specific type of string; see the documentation for the [[`getPlayerIndex`]]
  * function. Mods can signify that data structures handle EntityPlayers by using this type:
@@ -47,20 +46,6 @@ export declare function getLastHeart(player: EntityPlayer): HealthType;
  */
 export declare function getNewestPlayer(): EntityPlayer;
 export declare function getFinalPlayer(): EntityPlayer;
-/**
- * Returns the slot number corresponding to where a trinket can be safely inserted.
- *
- * Example:
- * ```
- * const player = Isaac.GetPlayer();
- * const trinketSlot = getOpenTrinketSlotNum(player);
- * if (trinketSlot !== undefined) {
- *   // They have one or more open trinket slots
- *   player.AddTrinket(TrinketType.TRINKET_SWALLOWED_PENNY);
- * }
- * ```
- */
-export declare function getOpenTrinketSlot(player: EntityPlayer): int | undefined;
 /**
  * Iterates over all players and checks if any are close enough to the specified position.
  *
@@ -115,17 +100,6 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  * This is equivalent to the number of hits that the player can currently take.
  */
 export declare function getPlayerNumAllHearts(player: EntityPlayer): int;
-/**
- * Use this helper function as a workaround for `EntityPlayer.GetPocketItem()` not working
- * correctly.
- *
- * Note that due to API limitations, there is no way to determine the location of a Dice Bag trinket
- * dice. Furthermore, when the player has a Dice Bag trinket dice and a pocket active at the same
- * time, there is no way to determine the location of the pocket active item. If this function
- * cannot determine the identity of a particular slot, it will mark the type of the slot as
- * `PocketItemType.UNDETERMINABLE`.
- */
-export declare function getPocketItems(player: EntityPlayer): PocketItemDescription[];
 /**
  * Helper function to return the active charge and the battery charge combined. This is useful
  * because you are not able to set the battery charge directly.
@@ -146,23 +120,6 @@ export declare function hasLostCurse(player: EntityPlayer): boolean;
  * items. (Only Tainted Forgotten can pick up items.)
  */
 export declare function hasOpenActiveItemSlot(player: EntityPlayer): boolean;
-/**
- * Returns whether or not the player can hold an additional pocket item, beyond what they are
- * currently carrying. This takes into account items that modify the max number of pocket items,
- * like Starter Deck.
- *
- * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
- * items. (Only Tainted Forgotten can pick up items.)
- */
-export declare function hasOpenPocketItemSlot(player: EntityPlayer): boolean;
-/**
- * Returns whether or not the player can hold an additional trinket, beyond what they are currently
- * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
- *
- * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
- * items. (Only Tainted Forgotten can pick up items.)
- */
-export declare function hasOpenTrinketSlot(player: EntityPlayer): boolean;
 /**
  * Helper function for detecting when a player is Bethany or Tainted Bethany. This is useful if you
  * need to adjust UI elements to account for Bethany's soul charges or Tainted Bethany's blood

package/dist/functions/player.lua

@@ -6,8 +6,6 @@ local ____constants = require("constants")
 local LOST_STYLE_PLAYER_TYPES = ____constants.LOST_STYLE_PLAYER_TYPES
 local ____HealthType = require("types.HealthType")
 local HealthType = ____HealthType.HealthType
-local ____PocketItemType = require("types.PocketItemType")
-local PocketItemType = ____PocketItemType.PocketItemType
 local ____bitwise = require("functions.bitwise")
 local getKBitOfN = ____bitwise.getKBitOfN
 local getNumBitsOfN = ____bitwise.getNumBitsOfN
@@ -29,18 +27,18 @@ function ____exports.getPlayers(self, performExclusions)
             do
                 local player = Isaac.GetPlayer(i)
                 if player == nil then
-                    goto __continue55
+                    goto __continue51
                 end
                 if ____exports.isChildPlayer(nil, player) then
-                    goto __continue55
+                    goto __continue51
                 end
                 local character = player:GetPlayerType()
                 if performExclusions and EXCLUDED_CHARACTERS:has(character) then
-                    goto __continue55
+                    goto __continue51
                 end
                 __TS__ArrayPush(players, player)
             end
-            ::__continue55::
+            ::__continue51::
             i = i + 1
         end
     end
@@ -210,24 +208,6 @@ function ____exports.getFinalPlayer(self)
     local players = ____exports.getPlayers(nil)
     return players[#players]
 end
-function ____exports.getOpenTrinketSlot(self, player)
-    local maxTrinkets = player:GetMaxTrinkets()
-    local trinket0 = player:GetTrinket(0)
-    local trinket1 = player:GetTrinket(1)
-    if maxTrinkets == 1 then
-        return ((trinket0 == TrinketType.TRINKET_NULL) and 0) or nil
-    end
-    if maxTrinkets == 2 then
-        if trinket0 == TrinketType.TRINKET_NULL then
-            return 0
-        end
-        return ((trinket1 == TrinketType.TRINKET_NULL) and 1) or nil
-    end
-    error(
-        "The player has an unknown number of trinket slots: " .. tostring(maxTrinkets)
-    )
-    return nil
-end
 function ____exports.getPlayerCloserThan(self, position, distance)
     for ____, player in ipairs(
         ____exports.getPlayers(nil)
@@ -283,14 +263,14 @@ function ____exports.getPlayerIndexVanilla(self, playerToFind)
             do
                 local player = Isaac.GetPlayer(i)
                 if player == nil then
-                    goto __continue64
+                    goto __continue60
                 end
                 local playerHash = GetPtrHash(player)
                 if playerHash == playerToFindHash then
                     return i
                 end
             end
-            ::__continue64::
+            ::__continue60::
             i = i + 1
         end
     end
@@ -303,43 +283,6 @@ function ____exports.getPlayerNumAllHearts(self, player)
     local eternalHearts = player:GetEternalHearts()
     return ((hearts + soulHearts) + boneHearts) + eternalHearts
 end
-function ____exports.getPocketItems(self, player)
-    local pocketItem = player:GetActiveItem(ActiveSlot.SLOT_POCKET)
-    local hasPocketItem = pocketItem ~= CollectibleType.COLLECTIBLE_NULL
-    local pocketItem2 = player:GetActiveItem(ActiveSlot.SLOT_POCKET2)
-    local hasPocketItem2 = pocketItem2 ~= CollectibleType.COLLECTIBLE_NULL
-    local maxPocketItems = player:GetMaxPocketItems()
-    local pocketItems = {}
-    local pocketItemIdentified = false
-    local pocketItem2Identified = false
-    do
-        local slot = 0
-        while slot < 4 do
-            local card = player:GetCard(slot)
-            local pill = player:GetPill(slot)
-            if card ~= Card.CARD_NULL then
-                __TS__ArrayPush(pocketItems, {type = PocketItemType.CARD, id = card})
-            elseif pill ~= PillColor.PILL_NULL then
-                __TS__ArrayPush(pocketItems, {type = PocketItemType.PILL, id = pill})
-            elseif (hasPocketItem and (not hasPocketItem2)) and (not pocketItemIdentified) then
-                pocketItemIdentified = true
-                __TS__ArrayPush(pocketItems, {type = PocketItemType.ACTIVE_ITEM, id = pocketItem})
-            elseif ((not hasPocketItem) and hasPocketItem2) and (not pocketItem2Identified) then
-                pocketItem2Identified = true
-                __TS__ArrayPush(pocketItems, {type = PocketItemType.DICE_BAG_DICE, id = pocketItem2})
-            elseif hasPocketItem and hasPocketItem2 then
-                __TS__ArrayPush(pocketItems, {type = PocketItemType.UNDETERMINABLE, id = 0})
-            else
-                __TS__ArrayPush(pocketItems, {type = PocketItemType.EMPTY, id = 0})
-            end
-            if (slot + 1) == maxPocketItems then
-                break
-            end
-            slot = slot + 1
-        end
-    end
-    return pocketItems
-end
 function ____exports.getTotalCharge(self, player, activeSlot)
     local activeCharge = player:GetActiveCharge(activeSlot)
     local batteryCharge = player:GetBatteryCharge(activeSlot)
@@ -371,27 +314,6 @@ function ____exports.hasOpenActiveItemSlot(self, player)
     end
     return activeItemPrimary == CollectibleType.COLLECTIBLE_NULL
 end
-function ____exports.hasOpenPocketItemSlot(self, player)
-    local character = player:GetPlayerType()
-    if character == PlayerType.PLAYER_THESOUL_B then
-        return false
-    end
-    local pocketItems = ____exports.getPocketItems(nil, player)
-    for ____, pocketItem in ipairs(pocketItems) do
-        if pocketItem.type == PocketItemType.EMPTY then
-            return true
-        end
-    end
-    return false
-end
-function ____exports.hasOpenTrinketSlot(self, player)
-    local character = player:GetPlayerType()
-    if character == PlayerType.PLAYER_THESOUL_B then
-        return false
-    end
-    local openTrinketSlot = ____exports.getOpenTrinketSlot(nil, player)
-    return openTrinketSlot ~= nil
-end
 function ____exports.isBethany(self, player)
     local character = player:GetPlayerType()
     return (character == PlayerType.PLAYER_BETHANY) or (character == PlayerType.PLAYER_BETHANY_B)
@@ -456,9 +378,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch106 = activeSlot
-        local ____cond106 = ____switch106 == ActiveSlot.SLOT_PRIMARY
-        if ____cond106 then
+        local ____switch87 = activeSlot
+        local ____cond87 = ____switch87 == ActiveSlot.SLOT_PRIMARY
+        if ____cond87 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -467,8 +389,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond106 = ____cond106 or (____switch106 == ActiveSlot.SLOT_SECONDARY)
-        if ____cond106 then
+        ____cond87 = ____cond87 or (____switch87 == ActiveSlot.SLOT_SECONDARY)
+        if ____cond87 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -483,16 +405,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond106 = ____cond106 or (____switch106 == ActiveSlot.SLOT_POCKET)
-        if ____cond106 then
+        ____cond87 = ____cond87 or (____switch87 == ActiveSlot.SLOT_POCKET)
+        if ____cond87 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond106 = ____cond106 or (____switch106 == ActiveSlot.SLOT_POCKET2)
-        if ____cond106 then
+        ____cond87 = ____cond87 or (____switch87 == ActiveSlot.SLOT_POCKET2)
+        if ____cond87 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/pocketItems.d.ts

@@ -1,21 +1,23 @@
 /// <reference types="isaac-typescript-definitions" />
+import { PocketItemDescription } from "../types/PocketItemDescription";
+export declare function getFirstCardOrPill(player: EntityPlayer): PocketItemDescription | undefined;
 /**
- * This is a helper function to get a card name from a Card.
+ * Use this helper function as a workaround for `EntityPlayer.GetPocketItem()` not working
+ * correctly.
  *
- * Example:
- * ```
- * const card = Card.CARD_FOOL;
- * const cardName = getCardName(card); // cardName is "0 - The Fool"
- * ```
+ * Note that due to API limitations, there is no way to determine the location of a Dice Bag trinket
+ * dice. Furthermore, when the player has a Dice Bag trinket dice and a pocket active at the same
+ * time, there is no way to determine the location of the pocket active item. If this function
+ * cannot determine the identity of a particular slot, it will mark the type of the slot as
+ * `PocketItemType.UNDETERMINABLE`.
  */
-export declare function getCardName(card: Card | int): string;
+export declare function getPocketItems(player: EntityPlayer): PocketItemDescription[];
 /**
- * This is a helper function to get a pill effect name from a PillEffect.
+ * Returns whether or not the player can hold an additional pocket item, beyond what they are
+ * currently carrying. This takes into account items that modify the max number of pocket items,
+ * like Starter Deck.
  *
- * Example:
- * ```
- * const pillEffect = PillEffect.PILLEFFECT_BAD_GAS;
- * const pillEffectName = getPillEffectName(pillEffect); // trinketName is "Bad Gas"
- * ```
+ * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
+ * items. (Only Tainted Forgotten can pick up items.)
  */
-export declare function getPillEffectName(pillEffect: PillEffect | int): string;
+export declare function hasOpenPocketItemSlot(player: EntityPlayer): boolean;

package/dist/functions/pocketItems.lua

@@ -1,39 +1,65 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+require("lualib_bundle");
 local ____exports = {}
-local ____cardNameMap = require("maps.cardNameMap")
-local CARD_NAME_MAP = ____cardNameMap.CARD_NAME_MAP
-local ____pillEffectNameMap = require("maps.pillEffectNameMap")
-local PILL_EFFECT_NAME_MAP = ____pillEffectNameMap.PILL_EFFECT_NAME_MAP
-function ____exports.getCardName(self, card)
-    local itemConfig = Isaac.GetItemConfig()
-    local defaultName = "Unknown"
-    if type(card) ~= "number" then
-        return defaultName
+local ____PocketItemType = require("types.PocketItemType")
+local PocketItemType = ____PocketItemType.PocketItemType
+function ____exports.getPocketItems(self, player)
+    local pocketItem = player:GetActiveItem(ActiveSlot.SLOT_POCKET)
+    local hasPocketItem = pocketItem ~= CollectibleType.COLLECTIBLE_NULL
+    local pocketItem2 = player:GetActiveItem(ActiveSlot.SLOT_POCKET2)
+    local hasPocketItem2 = pocketItem2 ~= CollectibleType.COLLECTIBLE_NULL
+    local maxPocketItems = player:GetMaxPocketItems()
+    local pocketItems = {}
+    local pocketItemIdentified = false
+    local pocketItem2Identified = false
+    do
+        local slot = 0
+        while slot < 4 do
+            local card = player:GetCard(slot)
+            local pill = player:GetPill(slot)
+            if card ~= Card.CARD_NULL then
+                __TS__ArrayPush(pocketItems, {type = PocketItemType.CARD, id = card})
+            elseif pill ~= PillColor.PILL_NULL then
+                __TS__ArrayPush(pocketItems, {type = PocketItemType.PILL, id = pill})
+            elseif (hasPocketItem and (not hasPocketItem2)) and (not pocketItemIdentified) then
+                pocketItemIdentified = true
+                __TS__ArrayPush(pocketItems, {type = PocketItemType.ACTIVE_ITEM, id = pocketItem})
+            elseif ((not hasPocketItem) and hasPocketItem2) and (not pocketItem2Identified) then
+                pocketItem2Identified = true
+                __TS__ArrayPush(pocketItems, {type = PocketItemType.DICE_BAG_DICE, id = pocketItem2})
+            elseif hasPocketItem and hasPocketItem2 then
+                __TS__ArrayPush(pocketItems, {type = PocketItemType.UNDETERMINABLE, id = 0})
+            else
+                __TS__ArrayPush(pocketItems, {type = PocketItemType.EMPTY, id = 0})
+            end
+            if (slot + 1) == maxPocketItems then
+                break
+            end
+            slot = slot + 1
+        end
     end
-    local cardName = CARD_NAME_MAP:get(card)
-    if cardName ~= nil then
-        return cardName
-    end
-    local itemConfigCard = itemConfig:GetCard(card)
-    if itemConfigCard == nil then
-        return defaultName
-    end
-    return itemConfigCard.Name
+    return pocketItems
 end
-function ____exports.getPillEffectName(self, pillEffect)
-    local itemConfig = Isaac.GetItemConfig()
-    local defaultName = "Unknown"
-    if type(pillEffect) ~= "number" then
-        return defaultName
+function ____exports.getFirstCardOrPill(self, player)
+    local pocketItems = ____exports.getPocketItems(nil, player)
+    for ____, pocketItem in ipairs(pocketItems) do
+        if (pocketItem.type == PocketItemType.CARD) or (pocketItem.type == PocketItemType.PILL) then
+            return pocketItem
+        end
     end
-    local pillEffectName = PILL_EFFECT_NAME_MAP:get(pillEffect)
-    if pillEffectName ~= nil then
-        return pillEffectName
+    return nil
+end
+function ____exports.hasOpenPocketItemSlot(self, player)
+    local character = player:GetPlayerType()
+    if character == PlayerType.PLAYER_THESOUL_B then
+        return false
     end
-    local itemConfigPillEffect = itemConfig:GetPillEffect(pillEffect)
-    if itemConfigPillEffect == nil then
-        return defaultName
+    local pocketItems = ____exports.getPocketItems(nil, player)
+    for ____, pocketItem in ipairs(pocketItems) do
+        if pocketItem.type == PocketItemType.EMPTY then
+            return true
+        end
     end
-    return itemConfigPillEffect.Name
+    return false
 end
 return ____exports

package/dist/functions/trinkets.d.ts

@@ -1,6 +1,20 @@
 /// <reference types="isaac-typescript-definitions" />
 export declare function getMaxTrinketID(): int;
-/** Helper function to get all of the collectible entities in the room. */
+/**
+ * Returns the slot number corresponding to where a trinket can be safely inserted.
+ *
+ * Example:
+ * ```
+ * const player = Isaac.GetPlayer();
+ * const trinketSlot = getOpenTrinketSlotNum(player);
+ * if (trinketSlot !== undefined) {
+ *   // They have one or more open trinket slots
+ *   player.AddTrinket(TrinketType.TRINKET_SWALLOWED_PENNY);
+ * }
+ * ```
+ */
+export declare function getOpenTrinketSlot(player: EntityPlayer): int | undefined;
+/** Helper function to get all of the trinket entities in the room. */
 export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
 /** This is a helper function to get a trinket description from a TrinketType. */
 export declare function getTrinketDescription(trinketType: TrinketType | int): string;
@@ -14,4 +28,12 @@ export declare function getTrinketDescription(trinketType: TrinketType | int): s
  * ```
  */
 export declare function getTrinketName(trinketType: TrinketType | int): string;
+/**
+ * Returns whether or not the player can hold an additional trinket, beyond what they are currently
+ * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
+ *
+ * If the player is the Tainted Soul, this always returns false, since that character cannot pick up
+ * items. (Only Tainted Forgotten can pick up items.)
+ */
+export declare function hasOpenTrinketSlot(player: EntityPlayer): boolean;
 export declare function isGoldenTrinket(trinketType: TrinketType | int): boolean;

package/dist/functions/trinkets.lua

@@ -11,6 +11,24 @@ function ____exports.getMaxTrinketID(self)
     local itemConfig = Isaac.GetItemConfig()
     return itemConfig:GetTrinkets().Size - 1
 end
+function ____exports.getOpenTrinketSlot(self, player)
+    local maxTrinkets = player:GetMaxTrinkets()
+    local trinket0 = player:GetTrinket(0)
+    local trinket1 = player:GetTrinket(1)
+    if maxTrinkets == 1 then
+        return ((trinket0 == TrinketType.TRINKET_NULL) and 0) or nil
+    end
+    if maxTrinkets == 2 then
+        if trinket0 == TrinketType.TRINKET_NULL then
+            return 0
+        end
+        return ((trinket1 == TrinketType.TRINKET_NULL) and 1) or nil
+    end
+    error(
+        "The player has an unknown number of trinket slots: " .. tostring(maxTrinkets)
+    )
+    return nil
+end
 function ____exports.getTrinkets(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
@@ -57,6 +75,14 @@ function ____exports.getTrinketName(self, trinketType)
     end
     return itemConfigItem.Name
 end
+function ____exports.hasOpenTrinketSlot(self, player)
+    local character = player:GetPlayerType()
+    if character == PlayerType.PLAYER_THESOUL_B then
+        return false
+    end
+    local openTrinketSlot = ____exports.getOpenTrinketSlot(nil, player)
+    return openTrinketSlot ~= nil
+end
 function ____exports.isGoldenTrinket(self, trinketType)
     return trinketType > GOLDEN_TRINKET_SHIFT
 end

package/dist/index.d.ts

@@ -32,6 +32,7 @@ export * from "./functions/pickups";
 export * from "./functions/pills";
 export * from "./functions/player";
 export * from "./functions/playerHealth";
+export * from "./functions/pocketItems";
 export * from "./functions/position";
 export * from "./functions/random";
 export * from "./functions/revive";

package/dist/index.lua

@@ -262,6 +262,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.pocketItems")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.position")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.485",
+  "version": "1.0.486",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.282",
+    "isaac-typescript-definitions": "^1.0.284",
     "isaacscript-lint": "^1.0.67",
     "typedoc": "^0.22.10",
     "typescript": "4.4.4",