isaacscript-common 1.2.71 → 1.2.72

package/dist/functions/array.lua

@@ -11,6 +11,8 @@ local ____exports = {}
 local ____random = require("functions.random")
 local getRandomInt = ____random.getRandomInt
 local nextSeed = ____random.nextSeed
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
 function ____exports.shuffleArrayInPlace(self, array, seed)
     if seed == nil then
         seed = Random()
@@ -66,13 +68,13 @@ function ____exports.arrayEquals(self, array1, array2)
 end
 function ____exports.initArray(self, defaultValue, size)
     local array = {}
-    do
-        local i = 0
-        while i < size do
+    ____repeat(
+        nil,
+        size,
+        function()
             __TS__ArrayPush(array, defaultValue)
-            i = i + 1
         end
-    end
+    )
     return array
 end
 function ____exports.isArrayInArray(self, arrayToMatch, parentArray)

package/dist/functions/collectibleCacheFlag.lua

@@ -15,6 +15,7 @@ local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____utils = require("functions.utils")
 local getEnumValues = ____utils.getEnumValues
+local ____repeat = ____utils["repeat"]
 local CACHE_FLAG_TO_COLLECTIBLES_MAP = __TS__New(Map)
 local function initCacheFlagMap(self)
     local maxCollectibleType = getMaxCollectibleType(nil)
@@ -43,13 +44,13 @@ function ____exports.getPlayerCollectiblesForCacheFlag(self, player, cacheFlag)
     local playerCollectibles = {}
     for ____, collectibleType in __TS__Iterator(collectiblesForCacheFlag:values()) do
         local numCollectibles = player:GetCollectibleNum(collectibleType)
-        do
-            local i = 0
-            while i < numCollectibles do
+        ____repeat(
+            nil,
+            numCollectibles,
+            function()
                 __TS__ArrayPush(playerCollectibles, collectibleType)
-                i = i + 1
             end
-        end
+        )
     end
     return playerCollectibles
 end

package/dist/functions/entity.lua

@@ -12,6 +12,8 @@ local STORY_BOSSES = ____constants.STORY_BOSSES
 local ____random = require("functions.random")
 local getRandom = ____random.getRandom
 local nextSeed = ____random.nextSeed
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
 function ____exports.getEntities(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
     if matchingVariant == nil then
         matchingVariant = -1
@@ -227,16 +229,11 @@ function ____exports.removeEntities(self, entities, cap)
         return false
     end
     local numEntitiesRemoved = 0
-    do
-        local i = 0
-        while i < #entities do
-            local entity = entities[i + 1]
-            entity:Remove()
-            numEntitiesRemoved = numEntitiesRemoved + 1
-            if cap ~= nil and numEntitiesRemoved >= cap then
-                return true
-            end
-            i = i + 1
+    for ____, entity in ipairs(entities) do
+        entity:Remove()
+        numEntitiesRemoved = numEntitiesRemoved + 1
+        if cap ~= nil and numEntitiesRemoved >= cap then
+            return true
         end
     end
     return true
@@ -311,15 +308,15 @@ end
 function ____exports.setEntityRandomColor(self, entity)
     local colorValues = {}
     local seed = entity.InitSeed
-    do
-        local i = 0
-        while i < 3 do
+    ____repeat(
+        nil,
+        3,
+        function()
             seed = nextSeed(nil, seed)
             local randomColorValue = getRandom(nil, seed)
             __TS__ArrayPush(colorValues, randomColorValue)
-            i = i + 1
         end
-    end
+    )
     local color = Color(colorValues[1], colorValues[2], colorValues[3])
     entity:SetColor(
         color,

package/dist/functions/familiars.lua

@@ -8,6 +8,8 @@ local FAMILIARS_THAT_SHOOT_PLAYER_TEARS = ____constants.FAMILIARS_THAT_SHOOT_PLA
 local ____entity = require("functions.entity")
 local getEntities = ____entity.getEntities
 local removeEntities = ____entity.removeEntities
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
 function ____exports.getFamiliars(self, matchingVariant, matchingSubType)
     if matchingVariant == nil then
         matchingVariant = -1
@@ -52,9 +54,10 @@ function ____exports.checkFamiliar(self, player, collectibleType, numTargetFamil
     local numFamiliarsToSpawn = numTargetFamiliars - #familiarsForThisPlayer
     local collectibleRNG = player:GetCollectibleRNG(collectibleType)
     local familiarSubTypeToUse = familiarSubType == nil and 0 or familiarSubType
-    do
-        local i = 0
-        while i < numFamiliarsToSpawn do
+    ____repeat(
+        nil,
+        numFamiliarsToSpawn,
+        function()
             collectibleRNG:Next()
             local familiar = game:Spawn(
                 EntityType.ENTITY_FAMILIAR,
@@ -68,9 +71,8 @@ function ____exports.checkFamiliar(self, player, collectibleType, numTargetFamil
             if familiar ~= nil then
                 familiar.Player = player
             end
-            i = i + 1
         end
-    end
+    )
     return numFamiliarsToSpawn
 end
 function ____exports.checkFamiliarFromCollectibles(self, player, collectibleType, familiarVariant, familiarSubType)

package/dist/functions/log.lua

@@ -10,6 +10,8 @@ local ____collectibles = require("functions.collectibles")
 local getCollectibleName = ____collectibles.getCollectibleName
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
+local ____player = require("functions.player")
+local getEffectsList = ____player.getEffectsList
 local ____trinkets = require("functions.trinkets")
 local getTrinketName = ____trinkets.getTrinketName
 function ____exports.getDebugPrependString(self, msg, numParentFunctions)
@@ -146,34 +148,27 @@ function ____exports.logTable(____table, parentTables)
     end
 end
 function ____exports.logTemporaryEffects(player)
-    local effects = player:GetEffects()
-    local effectsList = effects:GetEffectsList()
+    local effects = getEffectsList(nil, player)
     ____exports.log("Logging all player temporary effects:")
-    if effectsList.Size == 0 then
+    if #effects == 0 then
         ____exports.log("  n/a (no temporary effects)")
         return
     end
     do
         local i = 0
-        while i < effectsList.Size do
-            do
-                local effect = effectsList:Get(i)
-                if effect == nil then
-                    goto __continue38
-                end
-                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
+        while i < #effects do
+            local effect = effects[i + 1]
+            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
-            ::__continue38::
             i = i + 1
         end
     end

package/dist/functions/player.d.ts

@@ -67,6 +67,11 @@ export declare function getClosestPlayer(position: Vector): EntityPlayer;
  * Tainted Forgotten have a 20 frame death animation (i.e. the "ForgottenDeath" animation).
  */
 export declare function getDeathAnimationName(player: EntityPlayer): string;
+/**
+ * Helper function to get an array of temporary effects for a player. This is helpful so that you
+ * don't have to manually create an array from an `EffectsList` object.
+ */
+export declare function getEffectsList(player: EntityPlayer): TemporaryEffect[];
 /**
  * Helper function to return the player with the highest ID, according to the `Isaac.GetPlayer()`
  * method.

package/dist/functions/player.lua

@@ -4,10 +4,10 @@ local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
-local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local getPlayerIndexCollectibleType, getAdjustedPlayerName, isTaintedModded, DEFAULT_COLLECTIBLE_TYPE, EXCLUDED_CHARACTERS
@@ -74,15 +74,15 @@ end
 function getPlayerIndexCollectibleType(self, player, differentiateForgottenAndSoul)
     local character = player:GetPlayerType()
     repeat
-        local ____switch59 = character
-        local ____cond59 = ____switch59 == PlayerType.PLAYER_THESOUL
-        if ____cond59 then
+        local ____switch62 = character
+        local ____cond62 = ____switch62 == PlayerType.PLAYER_THESOUL
+        if ____cond62 then
             do
                 return differentiateForgottenAndSoul and CollectibleType.COLLECTIBLE_SPOON_BENDER or DEFAULT_COLLECTIBLE_TYPE
             end
         end
-        ____cond59 = ____cond59 or ____switch59 == PlayerType.PLAYER_LAZARUS2_B
-        if ____cond59 then
+        ____cond62 = ____cond62 or ____switch62 == PlayerType.PLAYER_LAZARUS2_B
+        if ____cond62 then
             do
                 return CollectibleType.COLLECTIBLE_INNER_EYE
             end
@@ -110,39 +110,39 @@ end
 function getAdjustedPlayerName(self, player)
     local character = player:GetPlayerType()
     repeat
-        local ____switch72 = character
-        local ____cond72 = ____switch72 == PlayerType.PLAYER_BLUEBABY or ____switch72 == PlayerType.PLAYER_BLUEBABY_B
-        if ____cond72 then
+        local ____switch75 = character
+        local ____cond75 = ____switch75 == PlayerType.PLAYER_BLUEBABY or ____switch75 == PlayerType.PLAYER_BLUEBABY_B
+        if ____cond75 then
             do
                 return "Blue Baby"
             end
         end
-        ____cond72 = ____cond72 or ____switch72 == PlayerType.PLAYER_LAZARUS2
-        if ____cond72 then
+        ____cond75 = ____cond75 or ____switch75 == PlayerType.PLAYER_LAZARUS2
+        if ____cond75 then
             do
                 return "Lazarus II"
             end
         end
-        ____cond72 = ____cond72 or ____switch72 == PlayerType.PLAYER_BLACKJUDAS
-        if ____cond72 then
+        ____cond75 = ____cond75 or ____switch75 == PlayerType.PLAYER_BLACKJUDAS
+        if ____cond75 then
             do
                 return "Dark Judas"
             end
         end
-        ____cond72 = ____cond72 or ____switch72 == PlayerType.PLAYER_JACOB
-        if ____cond72 then
+        ____cond75 = ____cond75 or ____switch75 == PlayerType.PLAYER_JACOB
+        if ____cond75 then
             do
                 return "Jacob & Esau"
             end
         end
-        ____cond72 = ____cond72 or ____switch72 == PlayerType.PLAYER_LAZARUS2_B
-        if ____cond72 then
+        ____cond75 = ____cond75 or ____switch75 == PlayerType.PLAYER_LAZARUS2_B
+        if ____cond75 then
             do
                 return "Dead Tainted Lazarus"
             end
         end
-        ____cond72 = ____cond72 or ____switch72 == PlayerType.PLAYER_JACOB2_B
-        if ____cond72 then
+        ____cond75 = ____cond75 or ____switch75 == PlayerType.PLAYER_JACOB2_B
+        if ____cond75 then
             do
                 return "Dead Tainted Jacob"
             end
@@ -159,22 +159,23 @@ function ____exports.getPlayers(self, performExclusions)
         performExclusions = false
     end
     local game = Game()
+    local numPlayers = game:GetNumPlayers()
     local players = {}
     do
         local i = 0
-        while i < game:GetNumPlayers() do
+        while i < numPlayers do
             do
                 local player = Isaac.GetPlayer(i)
                 if ____exports.isChildPlayer(nil, player) then
-                    goto __continue82
+                    goto __continue85
                 end
                 local character = player:GetPlayerType()
                 if performExclusions and EXCLUDED_CHARACTERS:has(character) then
-                    goto __continue82
+                    goto __continue85
                 end
                 __TS__ArrayPush(players, player)
             end
-            ::__continue82::
+            ::__continue85::
             i = i + 1
         end
     end
@@ -311,6 +312,22 @@ function ____exports.getDeathAnimationName(self, player)
     end
     return "Death"
 end
+function ____exports.getEffectsList(self, player)
+    local effects = player:GetEffects()
+    local effectsList = effects:GetEffectsList()
+    local effectArray = {}
+    do
+        local i = 0
+        while i < effectsList.Size do
+            local effect = effectsList:Get(i)
+            if effect ~= nil then
+                __TS__ArrayPush(effectArray, effect)
+            end
+            i = i + 1
+        end
+    end
+    return effectArray
+end
 function ____exports.getFinalPlayer(self)
     local players = ____exports.getPlayers(nil)
     return players[#players]
@@ -408,10 +425,11 @@ function ____exports.getPlayerFromIndex(self, playerIndex)
 end
 function ____exports.getPlayerIndexVanilla(self, playerToFind)
     local game = Game()
+    local numPlayers = game:GetNumPlayers()
     local playerToFindHash = GetPtrHash(playerToFind)
     do
         local i = 0
-        while i < game:GetNumPlayers() do
+        while i < numPlayers do
             local player = Isaac.GetPlayer(i)
             local playerHash = GetPtrHash(player)
             if playerHash == playerToFindHash then
@@ -548,9 +566,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch118 = activeSlot
-        local ____cond118 = ____switch118 == ActiveSlot.SLOT_PRIMARY
-        if ____cond118 then
+        local ____switch121 = activeSlot
+        local ____cond121 = ____switch121 == ActiveSlot.SLOT_PRIMARY
+        if ____cond121 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -559,8 +577,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond118 = ____cond118 or ____switch118 == ActiveSlot.SLOT_SECONDARY
-        if ____cond118 then
+        ____cond121 = ____cond121 or ____switch121 == ActiveSlot.SLOT_SECONDARY
+        if ____cond121 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -575,16 +593,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond118 = ____cond118 or ____switch118 == ActiveSlot.SLOT_POCKET
-        if ____cond118 then
+        ____cond121 = ____cond121 or ____switch121 == ActiveSlot.SLOT_POCKET
+        if ____cond121 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond118 = ____cond118 or ____switch118 == ActiveSlot.SLOT_POCKET2
-        if ____cond118 then
+        ____cond121 = ____cond121 or ____switch121 == ActiveSlot.SLOT_POCKET2
+        if ____cond121 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/position.lua

@@ -7,6 +7,7 @@ local anyEntityCloserThan = ____entity.anyEntityCloserThan
 local getEffects = ____entity.getEffects
 local ____player = require("functions.player")
 local getPlayerCloserThan = ____player.getPlayerCloserThan
+local MAX_FIND_FREE_POSITION_ATTEMPTS = 100
 function ____exports.findFreePosition(self, startingPosition, avoidActiveEntities)
     if avoidActiveEntities == nil then
         avoidActiveEntities = false
@@ -16,7 +17,7 @@ function ____exports.findFreePosition(self, startingPosition, avoidActiveEntitie
     local heavenDoors = getEffects(nil, EffectVariant.HEAVEN_LIGHT_DOOR, 0)
     do
         local i = 0
-        while i < 100 do
+        while i < MAX_FIND_FREE_POSITION_ATTEMPTS do
             do
                 local position = room:FindFreePickupSpawnPosition(startingPosition, i, avoidActiveEntities)
                 local closePlayer = getPlayerCloserThan(nil, position, DISTANCE_OF_GRID_TILE)

package/dist/functions/trinketCacheFlag.lua

@@ -10,13 +10,13 @@ local range = ____math.range
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____trinkets = require("functions.trinkets")
-local getMaxTrinketID = ____trinkets.getMaxTrinketID
+local getMaxTrinketType = ____trinkets.getMaxTrinketType
 local trinketHasCacheFlag = ____trinkets.trinketHasCacheFlag
 local ____utils = require("functions.utils")
 local getEnumValues = ____utils.getEnumValues
 local CACHE_FLAG_TO_TRINKETS_MAP = __TS__New(Map)
 local function initCacheFlagMap(self)
-    local maxTrinketID = getMaxTrinketID(nil)
+    local maxTrinketID = getMaxTrinketType(nil)
     for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
         local trinketsSet = __TS__New(Set)
         for ____, trinketType in ipairs(range(nil, 1, maxTrinketID)) do

package/dist/functions/trinketGive.lua

@@ -4,6 +4,8 @@ local ____constants = require("constants")
 local GOLDEN_TRINKET_SHIFT = ____constants.GOLDEN_TRINKET_SHIFT
 local ____player = require("functions.player")
 local useActiveItemTemp = ____player.useActiveItemTemp
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
 function ____exports.temporarilyRemoveTrinket(self, player, trinketType)
     if not player:HasTrinket(trinketType) then
         return nil
@@ -52,14 +54,14 @@ function ____exports.giveTrinketsBack(self, player, trinketSituation)
     if trinket2 ~= TrinketType.TRINKET_NULL then
         player:TryRemoveTrinket(trinket2)
     end
-    do
-        local i = 0
-        while i < trinketSituation.numSmeltedTrinkets do
+    ____repeat(
+        nil,
+        trinketSituation.numSmeltedTrinkets,
+        function()
             player:AddTrinket(trinketSituation.trinketTypeRemoved, false)
             useActiveItemTemp(nil, player, CollectibleType.COLLECTIBLE_SMELTER)
-            i = i + 1
         end
-    end
+    )
     if trinketSituation.trinket1 ~= TrinketType.TRINKET_NULL then
         player:AddTrinket(trinketSituation.trinket1, false)
     end

package/dist/functions/trinketSet.lua

@@ -3,21 +3,20 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+local ____math = require("functions.math")
+local range = ____math.range
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____trinkets = require("functions.trinkets")
-local getMaxTrinketID = ____trinkets.getMaxTrinketID
+local getMaxTrinketType = ____trinkets.getMaxTrinketType
 local TRINKET_SET = __TS__New(Set)
 local function initTrinketSet(self)
     local itemConfig = Isaac.GetItemConfig()
-    do
-        local trinketType = 1
-        while trinketType <= getMaxTrinketID(nil) do
-            local itemConfigTrinket = itemConfig:GetTrinket(trinketType)
-            if itemConfigTrinket ~= nil then
-                TRINKET_SET:add(trinketType)
-            end
-            trinketType = trinketType + 1
+    local maxTrinketID = getMaxTrinketType(nil)
+    for ____, trinketType in ipairs(range(nil, 1, maxTrinketID)) do
+        local itemConfigTrinket = itemConfig:GetTrinket(trinketType)
+        if itemConfigTrinket ~= nil then
+            TRINKET_SET:add(trinketType)
         end
     end
 end

package/dist/functions/trinkets.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare function getMaxTrinketID(): int;
+export declare function getMaxTrinketType(): int;
 /**
  * Returns the slot number corresponding to where a trinket can be safely inserted.
  *

package/dist/functions/trinkets.lua

@@ -15,7 +15,9 @@ local useActiveItemTemp = ____player.useActiveItemTemp
 local ____trinketGive = require("functions.trinketGive")
 local giveTrinketsBack = ____trinketGive.giveTrinketsBack
 local temporarilyRemoveTrinkets = ____trinketGive.temporarilyRemoveTrinkets
-function ____exports.getMaxTrinketID(self)
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
+function ____exports.getMaxTrinketType(self)
     local itemConfig = Isaac.GetItemConfig()
     return itemConfig:GetTrinkets().Size - 1
 end
@@ -88,14 +90,14 @@ function ____exports.smeltTrinket(self, player, trinketType, numTrinkets)
         numTrinkets = 1
     end
     local trinketSituation = temporarilyRemoveTrinkets(nil, player)
-    do
-        local i = 0
-        while i < numTrinkets do
+    ____repeat(
+        nil,
+        numTrinkets,
+        function()
             player:AddTrinket(trinketType)
             useActiveItemTemp(nil, player, CollectibleType.COLLECTIBLE_SMELTER)
-            i = i + 1
         end
-    end
+    )
     giveTrinketsBack(nil, player, trinketSituation)
 end
 function ____exports.trinketHasCacheFlag(self, trinketType, cacheFlag)

package/dist/functions/utils.d.ts

@@ -82,5 +82,21 @@ export declare function onSetSeed(): boolean;
 export declare function printConsole(msg: string): void;
 /**
  * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
+ *
+ * Example:
+ * ```ts
+ * const player = Isaac.GetPlayer();
+ * repeat(10, () => {
+ *   player.AddCollectible(CollectibleType.COLLECTIBLE_STEVEN);
+ * });
+ * ```
+ *
+ * The repeated function is passed the index of the iteration, if needed:
+ *
+ * ```ts
+ * repeat(3, (i) => {
+ *   print(i); // Prints "0", "1", "2"
+ * });
+ * ```
  */
 export declare function repeat(n: int, func: (i: int) => void): void;

package/package.json

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