isaacscript-common 1.2.216 → 1.2.219

package/dist/callbacks/customRevive.lua

@@ -16,6 +16,8 @@ local removeAllFamiliars = ____familiars.removeAllFamiliars
 local ____log = require("functions.log")
 local log = ____log.log
 local logError = ____log.logError
+local ____player = require("functions.player")
+local isCharacter = ____player.isCharacter
 local ____playerIndex = require("functions.playerIndex")
 local getPlayerFromIndex = ____playerIndex.getPlayerFromIndex
 local getPlayerIndex = ____playerIndex.getPlayerIndex
@@ -51,13 +53,12 @@ function checkWaitingForItemAnimation(self, player)
     if v.run.dyingPlayerIndex == nil then
         return
     end
-    local character = player:GetPlayerType()
     local playerIndex = getPlayerIndex(nil, player)
     if playerIndex ~= v.run.dyingPlayerIndex then
         return
     end
     local playerToCheckHoldingItem = player
-    if character == PlayerType.PLAYER_THESOUL_B then
+    if isCharacter(nil, player, PlayerType.PLAYER_THESOUL_B) then
         local forgottenBody = player:GetOtherTwin()
         if forgottenBody ~= nil then
             playerToCheckHoldingItem = forgottenBody

package/dist/features/extraConsoleCommands/commands.lua

@@ -19,12 +19,12 @@ local getCharacterName = ____character.getCharacterName
 local ____gridEntity = require("functions.gridEntity")
 local spawnGridEntityWithVariant = ____gridEntity.spawnGridEntityWithVariant
 local ____log = require("functions.log")
+local logEffects = ____log.logEffects
 local logEntities = ____log.logEntities
 local logGridEntities = ____log.logGridEntities
 local logRoom = ____log.logRoom
 local logSeedEffects = ____log.logSeedEffects
 local logSounds = ____log.logSounds
-local logTemporaryEffects = ____log.logTemporaryEffects
 local ____map = require("functions.map")
 local getMapPartialMatch = ____map.getMapPartialMatch
 local ____npc = require("functions.npc")
@@ -32,6 +32,7 @@ local getNPCs = ____npc.getNPCs
 local ____pills = require("functions.pills")
 local getPillEffectName = ____pills.getPillEffectName
 local ____player = require("functions.player")
+local getPlayerName = ____player.getPlayerName
 local useActiveItemTemp = ____player.useActiveItemTemp
 local ____playerHealth = require("functions.playerHealth")
 local addPlayerHealthType = ____playerHealth.addPlayerHealthType
@@ -487,7 +488,7 @@ function ____exports.dungeon(self)
 end
 function ____exports.effects(self)
     local player = Isaac.GetPlayer()
-    logTemporaryEffects(player)
+    logEffects(player)
     printConsole(nil, "Logged the player's effects to the \"log.txt\" file.")
 end
 function ____exports.eh(self, params)
@@ -501,10 +502,10 @@ function ____exports.fool(self)
 end
 function ____exports.getPosition(self)
     for ____, player in ipairs(getPlayers(nil)) do
-        local character = player:GetPlayerType()
+        local playerName = getPlayerName(nil, player)
         printConsole(
             nil,
-            ((((("Player position for character " .. tostring(character)) .. ": (") .. tostring(player.Position.X)) .. ", ") .. tostring(player.Position.Y)) .. ")"
+            ((((("Player position for " .. playerName) .. ": (") .. tostring(player.Position.X)) .. ", ") .. tostring(player.Position.Y)) .. ")"
         )
     end
 end

package/dist/functions/log.d.ts

@@ -14,6 +14,7 @@ export declare function logArray<T>(this: void, array: T[]): void;
 export declare function logColor(this: void, color: Color): void;
 /** Helper function for printing out every damage flag that is turned on. Useful when debugging. */
 export declare function logDamageFlags(this: void, flags: int): void;
+export declare function logEffects(this: void, player: EntityPlayer): void;
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
 export declare function logEntities(this: void, includeBackgroundEffects: boolean, entityTypeFilter?: EntityType | int): void;
 /** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
@@ -56,7 +57,6 @@ export declare function logSounds(this: void): void;
 export declare function logTable(this: void, table: unknown, parentTables?: number): void;
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export declare function logTearFlags(this: void, flags: int): void;
-export declare function logTemporaryEffects(this: void, player: EntityPlayer): void;
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */
 export declare function logUseFlags(this: void, flags: int): void;
 /**

package/dist/functions/log.lua

@@ -80,14 +80,14 @@ function ____exports.logFlags(flags, flagEnum, description)
     for key, value in pairs(flagEnum) do
         do
             if type(value) ~= "number" then
-                goto __continue35
+                goto __continue42
             end
             if hasFlag(nil, flags, value) then
                 ____exports.log(((("  Has flag: " .. tostring(key)) .. " (") .. tostring(value)) .. ")")
                 hasNoFlags = false
             end
         end
-        ::__continue35::
+        ::__continue42::
     end
     if hasNoFlags then
         ____exports.log("  n/a (no flags)")
@@ -114,6 +114,32 @@ end
 function ____exports.logDamageFlags(flags)
     ____exports.logFlags(flags, DamageFlag, "damage")
 end
+function ____exports.logEffects(player)
+    local effects = getEffectsList(nil, player)
+    ____exports.log("Logging player effects:")
+    if #effects == 0 then
+        ____exports.log("  n/a (no effects)")
+        return
+    end
+    __TS__ArrayForEach(
+        effects,
+        function(____, effect, i)
+            local effectDescription
+            if effect.Item:IsCollectible() then
+                local collectibleName = getCollectibleName(nil, effect.Item.ID)
+                effectDescription = "Collectible: " .. collectibleName
+            elseif effect.Item:IsTrinket() then
+                local trinketName = getTrinketName(nil, effect.Item.ID)
+                effectDescription = "Trinket: " .. trinketName
+            elseif effect.Item:IsNull() then
+                effectDescription = "Null item: " .. tostring(effect.Item.ID)
+            else
+                effectDescription = "Unknown type of effect: " .. tostring(effect.Item.ID)
+            end
+            ____exports.log(((((("  " .. tostring(i + 1)) .. ") ") .. effectDescription) .. " (x") .. tostring(effect.Count)) .. ")")
+        end
+    )
+end
 function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
     local headerMsg = "Entities in the room"
     if entityTypeFilter ~= nil then
@@ -394,30 +420,6 @@ end
 function ____exports.logTearFlags(flags)
     ____exports.logFlags(flags, TearFlags, "tear")
 end
-function ____exports.logTemporaryEffects(player)
-    local effects = getEffectsList(nil, player)
-    ____exports.log("Logging player temporary effects:")
-    if #effects == 0 then
-        ____exports.log("  n/a (no temporary effects)")
-        return
-    end
-    __TS__ArrayForEach(
-        effects,
-        function(____, effect, i)
-            if effect.Item:IsCollectible() then
-                local collectibleName = getCollectibleName(nil, effect.Item.ID)
-                ____exports.log((("  " .. tostring(i + 1)) .. ") ") .. collectibleName)
-            elseif effect.Item:IsTrinket() then
-                local trinketName = getTrinketName(nil, effect.Item.ID)
-                ____exports.log((("  " .. tostring(i + 1)) .. ") ") .. trinketName)
-            elseif effect.Item:IsNull() then
-                ____exports.log((("  " .. tostring(i + 1)) .. ") Null item: ") .. tostring(effect.Item.ID))
-            else
-                ____exports.log((("  " .. tostring(i + 1)) .. ") Unknown type of temporary effect: ") .. tostring(effect.Item.ID))
-            end
-        end
-    )
-end
 function ____exports.logUseFlags(flags)
     ____exports.logFlags(flags, UseFlag, "use")
 end
@@ -449,6 +451,7 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logArray = ____exports.logArray
     globals.logColor = ____exports.logColor
     globals.logDamageFlags = ____exports.logDamageFlags
+    globals.logEffects = ____exports.logEffects
     globals.logEntities = ____exports.logEntities
     globals.logEntityID = ____exports.logEntityID
     globals.logEntityFlags = ____exports.logEntityFlags
@@ -466,7 +469,6 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logSounds = ____exports.logSounds
     globals.logTable = ____exports.logTable
     globals.logTearFlags = ____exports.logTearFlags
-    globals.logTemporaryEffects = ____exports.logTemporaryEffects
     globals.logUseFlags = ____exports.logUseFlags
     globals.logUserdata = ____exports.logUserdata
     globals.logVector = ____exports.logVector

package/dist/functions/player.d.ts

@@ -186,6 +186,13 @@ export declare function isActiveSlotEmpty(player: EntityPlayer, activeSlot: Acti
  * charges.
  */
 export declare function isBethany(player: EntityPlayer): boolean;
+/**
+ * Helper function to check if a player is a specific character (i.e. `PlayerType`).
+ *
+ * This function is variadic, meaning that you can supply as many characters as you want to check
+ * for. Returns true if the player is any of the supplied characters.
+ */
+export declare function isCharacter(player: EntityPlayer, ...characters: Array<PlayerType | int>): boolean;
 /**
  * Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where
  * you want to know if the starting stats were randomized, for example.

package/dist/functions/player.lua

@@ -64,6 +64,12 @@ function ____exports.getPlayerMaxHeartContainers(self, player)
     end
     return characterMaxHeartContainers
 end
+function ____exports.isCharacter(self, player, ...)
+    local characters = {...}
+    local characterSet = __TS__New(Set, characters)
+    local character = player:GetPlayerType()
+    return characterSet:has(character)
+end
 function ____exports.isKeeper(self, player)
     local character = player:GetPlayerType()
     return character == PlayerType.PLAYER_KEEPER or character == PlayerType.PLAYER_KEEPER_B
@@ -391,8 +397,7 @@ function ____exports.hasLostCurse(self, player)
     return effects:HasNullEffect(112)
 end
 function ____exports.hasOpenActiveItemSlot(self, player)
-    local character = player:GetPlayerType()
-    if character == PlayerType.PLAYER_THESOUL_B then
+    if ____exports.isCharacter(nil, player, PlayerType.PLAYER_THESOUL_B) then
         return false
     end
     local activeItemPrimary = player:GetActiveItem(ActiveSlot.SLOT_PRIMARY)
@@ -478,9 +483,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch100 = activeSlot
-        local ____cond100 = ____switch100 == ActiveSlot.SLOT_PRIMARY
-        if ____cond100 then
+        local ____switch101 = activeSlot
+        local ____cond101 = ____switch101 == ActiveSlot.SLOT_PRIMARY
+        if ____cond101 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -489,8 +494,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond100 = ____cond100 or ____switch100 == ActiveSlot.SLOT_SECONDARY
-        if ____cond100 then
+        ____cond101 = ____cond101 or ____switch101 == ActiveSlot.SLOT_SECONDARY
+        if ____cond101 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -505,16 +510,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond100 = ____cond100 or ____switch100 == ActiveSlot.SLOT_POCKET
-        if ____cond100 then
+        ____cond101 = ____cond101 or ____switch101 == ActiveSlot.SLOT_POCKET
+        if ____cond101 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond100 = ____cond100 or ____switch100 == ActiveSlot.SLOT_POCKET2
-        if ____cond100 then
+        ____cond101 = ____cond101 or ____switch101 == ActiveSlot.SLOT_POCKET2
+        if ____cond101 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/playerHealth.lua

@@ -10,6 +10,7 @@ local ____player = require("functions.player")
 local getPlayerBlackHearts = ____player.getPlayerBlackHearts
 local getPlayerHearts = ____player.getPlayerHearts
 local getPlayerSoulHearts = ____player.getPlayerSoulHearts
+local isCharacter = ____player.isCharacter
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 local ____repeat = ____utils["repeat"]
@@ -213,7 +214,6 @@ function ____exports.getPlayerHealthType(self, player, healthType)
     until true
 end
 function ____exports.removeAllPlayerHealth(self, player)
-    local character = player:GetPlayerType()
     local goldenHearts = player:GetGoldenHearts()
     local eternalHearts = player:GetEternalHearts()
     local boneHearts = player:GetBoneHearts()
@@ -224,7 +224,7 @@ function ____exports.removeAllPlayerHealth(self, player)
     player:AddBrokenHearts(brokenHearts * -1)
     player:AddMaxHearts(MAX_PLAYER_HEART_CONTAINERS * -2, true)
     player:AddSoulHearts(MAX_PLAYER_HEART_CONTAINERS * -2)
-    if character == PlayerType.PLAYER_THESOUL then
+    if isCharacter(nil, player, PlayerType.PLAYER_THESOUL) then
         local forgotten = player:GetSubPlayer()
         if forgotten ~= nil then
             local forgottenBoneHearts = forgotten:GetBoneHearts()
@@ -235,7 +235,6 @@ end
 function ____exports.setPlayerHealth(self, player, playerHealth)
     local character = player:GetPlayerType()
     local subPlayer = player:GetSubPlayer()
-    local isTaintedMagdalene = character == PlayerType.PLAYER_MAGDALENE_B
     ____exports.removeAllPlayerHealth(nil, player)
     if character == PlayerType.PLAYER_THESOUL and subPlayer ~= nil then
         subPlayer:AddMaxHearts(playerHealth.maxHearts, false)
@@ -269,7 +268,7 @@ function ____exports.setPlayerHealth(self, player, playerHealth)
         playerHealth.hearts,
         function()
             player:AddHearts(1)
-            if isTaintedMagdalene then
+            if character == PlayerType.PLAYER_MAGDALENE_B then
                 player:AddHearts(-1)
             end
         end

package/dist/functions/pocketItems.lua

@@ -9,6 +9,8 @@ local ____PocketItemType = require("enums.PocketItemType")
 local PocketItemType = ____PocketItemType.PocketItemType
 local ____math = require("functions.math")
 local range = ____math.range
+local ____player = require("functions.player")
+local isCharacter = ____player.isCharacter
 function ____exports.getPocketItems(self, player)
     local pocketItem = player:GetActiveItem(ActiveSlot.SLOT_POCKET)
     local hasPocketItem = pocketItem ~= CollectibleType.COLLECTIBLE_NULL
@@ -50,8 +52,7 @@ function ____exports.getFirstCardOrPill(self, player)
     )
 end
 function ____exports.hasOpenPocketItemSlot(self, player)
-    local character = player:GetPlayerType()
-    if character == PlayerType.PLAYER_THESOUL_B then
+    if isCharacter(nil, player, PlayerType.PLAYER_THESOUL_B) then
         return false
     end
     local pocketItems = ____exports.getPocketItems(nil, player)

package/dist/functions/trinkets.lua

@@ -15,6 +15,7 @@ local hasFlag = ____flag.hasFlag
 local ____pickups = require("functions.pickups")
 local getPickups = ____pickups.getPickups
 local ____player = require("functions.player")
+local isCharacter = ____player.isCharacter
 local useActiveItemTemp = ____player.useActiveItemTemp
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
@@ -71,8 +72,7 @@ function ____exports.getTrinkets(self, matchingSubType)
     return getPickups(nil, 350, matchingSubType)
 end
 function ____exports.hasOpenTrinketSlot(self, player)
-    local character = player:GetPlayerType()
-    if character == PlayerType.PLAYER_THESOUL_B then
+    if isCharacter(nil, player, PlayerType.PLAYER_THESOUL_B) then
         return false
     end
     local openTrinketSlot = ____exports.getOpenTrinketSlot(nil, player)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.216",
+  "version": "1.2.219",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",