isaacscript-common 1.2.275 → 1.2.278

package/dist/functions/boss.d.ts

@@ -44,8 +44,9 @@ export declare function isSin(npc: EntityNPC): boolean;
  * Use this function instead of `spawnNPC` since it handles automatically spawning multiple segments
  * for multi-segment bosses.
  *
- * By default, this will spawn Chub (and his variants) with 3 segments and other multi-segment
- * bosses with 4 segments. You can customize this via the "numSegments" argument.
+ * By default, this will spawn Chub (and his variants) with 3 segments, Lokii with 2 copies,
+ * Gurglings/Turdlings with 2 copies, and other multi-segment bosses with 4 segments. You can
+ * customize this via the "numSegments" argument.
  */
 export declare function spawnBoss<T extends number>(entityType: T extends EntityTypeNonNPC ? never : T, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined, numSegments?: int): EntityNPC;
 /**

package/dist/functions/boss.lua

@@ -3,6 +3,7 @@ local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
+local getNumBossSegments, DEFAULT_BOSS_MULTI_SEGMENTS
 local ____constants = require("constants")
 local VectorZero = ____constants.VectorZero
 local ____bossSets = require("sets.bossSets")
@@ -20,7 +21,45 @@ local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
-local BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS = __TS__New(Set, {EntityType.ENTITY_LARRYJR, EntityType.ENTITY_CHUB, EntityType.ENTITY_TURDLET})
+function getNumBossSegments(self, entityType, variant, numSegments)
+    if numSegments ~= nil then
+        return numSegments
+    end
+    repeat
+        local ____switch18 = entityType
+        local ____cond18 = ____switch18 == EntityType.ENTITY_CHUB
+        if ____cond18 then
+            do
+                return 3
+            end
+        end
+        ____cond18 = ____cond18 or ____switch18 == EntityType.ENTITY_LOKI
+        if ____cond18 then
+            do
+                return variant == 1 and 2 or 1
+            end
+        end
+        ____cond18 = ____cond18 or ____switch18 == EntityType.ENTITY_GURGLING
+        if ____cond18 then
+            do
+                return 2
+            end
+        end
+        do
+            do
+                return DEFAULT_BOSS_MULTI_SEGMENTS
+            end
+        end
+    until true
+end
+local BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS = __TS__New(Set, {
+    EntityType.ENTITY_LARRYJR,
+    EntityType.ENTITY_CHUB,
+    EntityType.ENTITY_LOKI,
+    EntityType.ENTITY_GURGLING,
+    EntityType.ENTITY_TURDLET
+})
+DEFAULT_BOSS_MULTI_SEGMENTS = 4
 function ____exports.getAliveBosses(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
     if ignoreFriendly == nil then
         ignoreFriendly = false
@@ -98,9 +137,8 @@ function ____exports.spawnBoss(self, entityType, variant, subType, position, vel
         seed
     )
     if BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS:has(entityType) then
-        local numSegmentsDefined = numSegments == nil and 4 or numSegments
-        local numSegmentsToUse = entityType == EntityType.ENTITY_CHUB and 3 or numSegmentsDefined
-        local remainingSegmentsToSpawn = numSegmentsToUse - 1
+        local numBossSegments = getNumBossSegments(nil, entityType, variant, numSegments)
+        local remainingSegmentsToSpawn = numBossSegments - 1
         ____repeat(
             nil,
             remainingSegmentsToSpawn,

package/dist/functions/doors.d.ts

@@ -29,6 +29,8 @@ export declare function getDoors(...roomTypes: RoomType[]): GridEntityDoor[];
  */
 export declare function getDoorsToRoomIndex(...roomGridIndex: int[]): GridEntityDoor[];
 export declare function getRepentanceDoor(): GridEntityDoor | undefined;
+/** Helper function to find unused door slots in the room that can be used to make custom doors. */
+export declare function getUnusedDoorSlots(): DoorSlot[];
 export declare function isAngelRoomDoor(door: GridEntityDoor): boolean;
 export declare function isDevilRoomDoor(door: GridEntityDoor): boolean;
 /** Helper function to see if a door slot could exist for a given room shape. */

package/dist/functions/doors.lua

@@ -12,6 +12,8 @@ local ____doorSlotToDirection = require("objects.doorSlotToDirection")
 local DOOR_SLOT_TO_DIRECTION = ____doorSlotToDirection.DOOR_SLOT_TO_DIRECTION
 local ____roomShapeToDoorSlots = require("objects.roomShapeToDoorSlots")
 local ROOM_SHAPE_TO_DOOR_SLOTS = ____roomShapeToDoorSlots.ROOM_SHAPE_TO_DOOR_SLOTS
+local ____utils = require("functions.utils")
+local getEnumValues = ____utils.getEnumValues
 function ____exports.getDoors(self, ...)
     local roomTypes = {...}
     local room = game:GetRoom()
@@ -116,6 +118,14 @@ function ____exports.getRepentanceDoor(self)
         function(____, door) return ____exports.isRepentanceDoor(nil, door) end
     )
 end
+function ____exports.getUnusedDoorSlots(self)
+    local room = game:GetRoom()
+    local doorSlots = getEnumValues(nil, DoorSlot)
+    return __TS__ArrayFilter(
+        doorSlots,
+        function(____, doorSlot) return room:IsDoorSlotAllowed(doorSlot) and room:GetDoor(doorSlot) == nil end
+    )
+end
 function ____exports.isAngelRoomDoor(self, door)
     return door.TargetRoomType == RoomType.ROOM_ANGEL
 end

package/dist/functions/log.lua

@@ -82,14 +82,14 @@ function ____exports.logFlags(flags, flagEnum, description)
     for key, value in pairs(flagEnum) do
         do
             if type(value) ~= "number" then
-                goto __continue42
+                goto __continue43
             end
             if hasFlag(nil, flags, value) then
                 ____exports.log(((("  Has flag: " .. tostring(key)) .. " (") .. tostring(value)) .. ")")
                 hasNoFlags = false
             end
         end
-        ::__continue42::
+        ::__continue43::
     end
     if hasNoFlags then
         ____exports.log("  n/a (no flags)")
@@ -143,15 +143,13 @@ function ____exports.logEffects(player)
     )
 end
 function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
-    local headerMsg = "Entities in the room"
+    local msg = "Entities in the room"
     if entityTypeFilter ~= nil then
-        headerMsg = headerMsg .. (" (filtered to entity type " .. tostring(entityTypeFilter)) .. ")"
+        msg = msg .. (" (filtered to entity type " .. tostring(entityTypeFilter)) .. ")"
+    elseif not includeBackgroundEffects then
+        msg = msg .. " (not including background effects)"
     end
-    if not includeBackgroundEffects then
-        headerMsg = headerMsg .. " (not excluding background effects)"
-    end
-    headerMsg = headerMsg .. ":"
-    ____exports.log(headerMsg)
+    msg = msg .. ":\n"
     local entities = getEntities(nil)
     local numMatchedEntities = 0
     __TS__ArrayForEach(
@@ -164,62 +162,70 @@ function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
                 return
             end
             local entityID = getEntityID(nil, entity)
-            local debugString = (tostring(i + 1) .. " - ") .. entityID
+            msg = msg .. (tostring(i + 1) .. ") ") .. entityID
             local bomb = entity:ToBomb()
             if bomb ~= nil then
-                debugString = debugString .. " (bomb)"
+                msg = msg .. " (bomb)"
             end
             local effect = entity:ToEffect()
             if effect ~= nil then
-                debugString = debugString .. (" (effect) (State: " .. tostring(effect.State)) .. ")"
+                msg = msg .. (" (effect) (State: " .. tostring(effect.State)) .. ")"
             end
             local familiar = entity:ToFamiliar()
             if familiar ~= nil then
-                debugString = debugString .. (" (familiar) (State: " .. tostring(familiar.State)) .. ")"
+                msg = msg .. (" (familiar) (State: " .. tostring(familiar.State)) .. ")"
             end
             local knife = entity:ToKnife()
             if knife ~= nil then
-                debugString = debugString .. " (knife)"
+                msg = msg .. " (knife)"
             end
             local laser = entity:ToLaser()
             if laser ~= nil then
-                debugString = debugString .. " (laser)"
+                msg = msg .. " (laser)"
             end
             local npc = entity:ToNPC()
             if npc ~= nil then
-                debugString = debugString .. (((" (NPC) (State: " .. tostring(npc.State)) .. ") (CanShutDoors: ") .. tostring(npc.CanShutDoors)) .. ")"
+                msg = msg .. (" (NPC) (State: " .. tostring(npc.State)) .. ")"
             end
             local pickup = entity:ToPickup()
             if pickup ~= nil then
-                debugString = debugString .. (" (pickup) (State: " .. tostring(pickup.State)) .. ")"
+                msg = msg .. (" (pickup) (State: " .. tostring(pickup.State)) .. ")"
             end
             local player = entity:ToPlayer()
             if player ~= nil then
-                debugString = debugString .. " (player)"
+                msg = msg .. " (player)"
             end
             local projectile = entity:ToProjectile()
             if projectile ~= nil then
-                debugString = debugString .. " (projectile)"
+                msg = msg .. " (projectile)"
             end
             local tear = entity:ToTear()
             if tear ~= nil then
-                debugString = debugString .. " (tear)"
+                msg = msg .. " (tear)"
+            end
+            msg = msg .. "\n"
+            msg = msg .. ("  - Index: " .. tostring(entity.Index)) .. "\n"
+            msg = msg .. ("  - InitSeed: " .. tostring(entity.InitSeed)) .. "\n"
+            msg = msg .. ("  - DropSeed: " .. tostring(entity.DropSeed)) .. "\n"
+            msg = msg .. ((("  - Position: (" .. tostring(entity.Position.X)) .. ", ") .. tostring(entity.Position.Y)) .. ")\n"
+            msg = msg .. ((("  - Velocity: (" .. tostring(entity.Velocity.X)) .. ", ") .. tostring(entity.Velocity.Y)) .. ")\n"
+            msg = msg .. ((("  - HP: " .. tostring(entity.HitPoints)) .. " / ") .. tostring(entity.MaxHitPoints)) .. "\n"
+            msg = msg .. ("  - Parent: " .. tostring(entity.Parent)) .. "\n"
+            msg = msg .. ("  - Child: " .. tostring(entity.Child)) .. "\n"
+            msg = msg .. ("  - SpawnerEntity: " .. tostring(entity.SpawnerEntity)) .. "\n"
+            msg = msg .. ((("  - SpawnerType / SpawnerVariant: " .. tostring(entity.SpawnerType)) .. ".") .. tostring(entity.SpawnerVariant)) .. "\n"
+            if npc ~= nil then
+                msg = msg .. ("  - CanShutDoors: " .. tostring(npc.CanShutDoors)) .. "\n"
             end
-            debugString = debugString .. (" (Index: " .. tostring(entity.Index)) .. ")"
-            debugString = debugString .. (" (InitSeed: " .. tostring(entity.InitSeed)) .. ")"
-            debugString = debugString .. (" (DropSeed: " .. tostring(entity.DropSeed)) .. ")"
-            debugString = debugString .. (((" (Position: " .. tostring(entity.Position.X)) .. ", ") .. tostring(entity.Position.Y)) .. ")"
-            debugString = debugString .. (((" (Velocity: " .. tostring(entity.Velocity.X)) .. ", ") .. tostring(entity.Velocity.Y)) .. ")"
-            debugString = debugString .. (((" (HP: " .. tostring(entity.HitPoints)) .. " / ") .. tostring(entity.MaxHitPoints)) .. ")"
-            ____exports.log(debugString)
             numMatchedEntities = numMatchedEntities + 1
         end
     )
     if numMatchedEntities == 0 then
-        ____exports.log("(no entities matched)")
+        msg = msg .. "(no entities matched)\n"
     else
-        ____exports.log(("(" .. tostring(numMatchedEntities)) .. " total entities)")
+        msg = msg .. ("(" .. tostring(numMatchedEntities)) .. " total entities)\n"
     end
+    ____exports.log(msg)
 end
 function ____exports.logEntityFlags(flags)
     ____exports.logFlags(flags, EntityFlag, "entity")
@@ -248,14 +254,13 @@ function ____exports.logGameStateFlags()
     end
 end
 function ____exports.logGridEntities(includeWalls, gridEntityTypeFilter)
-    local headerMsg = "Grid entities in the room"
+    local msg = "Grid entities in the room"
     if gridEntityTypeFilter ~= nil then
-        headerMsg = headerMsg .. (" (filtered to grid entity type " .. tostring(gridEntityTypeFilter)) .. ")"
+        msg = msg .. (" (filtered to grid entity type " .. tostring(gridEntityTypeFilter)) .. ")"
+    elseif not includeWalls then
+        msg = msg .. " (not including walls)"
     end
-    if not includeWalls then
-        headerMsg = headerMsg .. " (not including walls)"
-    end
-    ____exports.log(headerMsg)
+    msg = msg .. ":\n"
     local gridEntities = getGridEntities(nil)
     local numMatchedEntities = 0
     __TS__ArrayForEach(
@@ -271,47 +276,54 @@ function ____exports.logGridEntities(includeWalls, gridEntityTypeFilter)
             if not includeWalls and gridEntityType == GridEntityType.GRID_WALL and gridEntityTypeFilter ~= GridEntityType.GRID_WALL then
                 return
             end
-            local debugString = (((((tostring(gridEntityIndex) .. " - ") .. tostring(gridEntityType)) .. ".") .. tostring(gridEntityVariant)) .. ".") .. tostring(gridEntity.State)
+            msg = msg .. (((((tostring(gridEntityIndex) .. ") ") .. tostring(gridEntityType)) .. ".") .. tostring(gridEntityVariant)) .. ".") .. tostring(gridEntity.State)
             local door = gridEntity:ToDoor()
             if door ~= nil then
-                debugString = debugString .. (((((((" (door) (Slot: " .. tostring(door.Slot)) .. ", Direction: ") .. tostring(door.Direction)) .. ", TargetRoomIndex: ") .. tostring(door.TargetRoomIndex)) .. ", TargetRoomType: ") .. tostring(door.TargetRoomType)) .. ")"
+                msg = msg .. " (door)"
             end
             local pit = gridEntity:ToPit()
             if pit ~= nil then
-                debugString = debugString .. " (pit)"
+                msg = msg .. " (pit)"
             end
             local poop = gridEntity:ToPoop()
             if poop ~= nil then
-                debugString = debugString .. " (poop)"
+                msg = msg .. " (poop)"
             end
             local pressurePlate = gridEntity:ToPressurePlate()
             if pressurePlate ~= nil then
-                debugString = debugString .. " (pressurePlate)"
+                msg = msg .. " (pressurePlate)"
             end
             local rock = gridEntity:ToRock()
             if rock ~= nil then
-                debugString = debugString .. " (rock)"
+                msg = msg .. " (rock)"
             end
             local spikes = gridEntity:ToSpikes()
             if spikes ~= nil then
-                debugString = debugString .. " (spikes)"
+                msg = msg .. " (spikes)"
             end
             local tnt = gridEntity:ToTNT()
             if tnt ~= nil then
-                debugString = debugString .. " (TNT)"
+                msg = msg .. " (TNT)"
+            end
+            msg = msg .. ("  - VarData: " .. tostring(gridEntity.VarData)) .. "\n"
+            msg = msg .. ((("  - Position: (" .. tostring(gridEntity.Position.X)) .. ", ") .. tostring(gridEntity.Position.Y)) .. ")\n"
+            msg = msg .. ("  - SpawnSeed: " .. tostring(gridEntityDesc.SpawnSeed)) .. "\n"
+            msg = msg .. ("  - VariableSeed: " .. tostring(gridEntityDesc.VariableSeed)) .. ")\n"
+            if door ~= nil then
+                msg = msg .. ("  - Slot: " .. tostring(door.Slot)) .. "\n"
+                msg = msg .. ("  - Direction: " .. tostring(door.Direction)) .. "\n"
+                msg = msg .. ("  - TargetRoomIndex: " .. tostring(door.TargetRoomIndex)) .. "\n"
+                msg = msg .. ("  - TargetRoomType: " .. tostring(door.TargetRoomType)) .. "\n"
             end
-            debugString = debugString .. (" (VarData: " .. tostring(gridEntity.VarData)) .. ")"
-            debugString = debugString .. (((" (Position: " .. tostring(gridEntity.Position.X)) .. ", ") .. tostring(gridEntity.Position.Y)) .. ")"
-            debugString = debugString .. (((" (SpawnSeed: " .. tostring(gridEntityDesc.SpawnSeed)) .. ", VariableSeed: ") .. tostring(gridEntityDesc.VariableSeed)) .. ")"
-            ____exports.log(debugString)
             numMatchedEntities = numMatchedEntities + 1
         end
     )
     if numMatchedEntities == 0 then
-        ____exports.log("(no grid entities matched)")
+        msg = msg .. "(no grid entities matched)\n"
     else
-        ____exports.log(("(" .. tostring(numMatchedEntities)) .. " total grid entities)")
+        msg = msg .. ("(" .. tostring(numMatchedEntities)) .. " total grid entities)\n"
     end
+    ____exports.log(msg)
 end
 function ____exports.logKColor(kColor)
     ____exports.log((((((("Color: R" .. tostring(kColor.Red)) .. ", G") .. tostring(kColor.Green)) .. ", B") .. tostring(kColor.Blue)) .. ", A") .. tostring(kColor.Alpha))

package/dist/functions/trinketGive.lua

@@ -10,13 +10,13 @@ function ____exports.giveTrinketsBack(self, player, trinketSituation)
     if trinketSituation == nil then
         return
     end
-    local trinket1 = player:GetTrinket(0)
-    local trinket2 = player:GetTrinket(1)
-    if trinket1 ~= TrinketType.TRINKET_NULL then
-        player:TryRemoveTrinket(trinket1)
+    local trinketType1 = player:GetTrinket(0)
+    local trinketType2 = player:GetTrinket(1)
+    if trinketType1 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinketType1)
     end
-    if trinket2 ~= TrinketType.TRINKET_NULL then
-        player:TryRemoveTrinket(trinket2)
+    if trinketType2 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinketType2)
     end
     ____repeat(
         nil,
@@ -26,47 +26,47 @@ function ____exports.giveTrinketsBack(self, player, trinketSituation)
             useActiveItemTemp(nil, player, CollectibleType.COLLECTIBLE_SMELTER)
         end
     )
-    if trinketSituation.trinket1 ~= TrinketType.TRINKET_NULL then
-        player:AddTrinket(trinketSituation.trinket1, false)
+    if trinketSituation.trinketType1 ~= TrinketType.TRINKET_NULL then
+        player:AddTrinket(trinketSituation.trinketType1, false)
     end
-    if trinketSituation.trinket2 ~= TrinketType.TRINKET_NULL then
-        player:AddTrinket(trinketSituation.trinket2, false)
+    if trinketSituation.trinketType2 ~= TrinketType.TRINKET_NULL then
+        player:AddTrinket(trinketSituation.trinketType2, false)
     end
 end
 function ____exports.temporarilyRemoveTrinket(self, player, trinketType)
     if not player:HasTrinket(trinketType) then
         return nil
     end
-    local trinket1 = player:GetTrinket(0)
-    local trinket2 = player:GetTrinket(1)
+    local trinketType1 = player:GetTrinket(0)
+    local trinketType2 = player:GetTrinket(1)
     local numTrinkets = 0
     while player:HasTrinket(trinketType) do
         player:TryRemoveTrinket(trinketType)
         numTrinkets = numTrinkets + 1
     end
     local numSmeltedTrinkets = numTrinkets
-    local trinketWasInSlot1 = trinket1 == trinketType or trinket1 + TRINKET_GOLDEN_FLAG == trinketType
+    local trinketWasInSlot1 = trinketType1 == trinketType or trinketType1 + TRINKET_GOLDEN_FLAG == trinketType
     if trinketWasInSlot1 then
         numSmeltedTrinkets = numSmeltedTrinkets - 1
     end
-    local trinketWasInSlot2 = trinket2 == trinketType or trinket2 + TRINKET_GOLDEN_FLAG == trinketType
+    local trinketWasInSlot2 = trinketType2 == trinketType or trinketType2 + TRINKET_GOLDEN_FLAG == trinketType
     if trinketWasInSlot2 then
         numSmeltedTrinkets = numSmeltedTrinkets - 1
     end
-    return {trinketTypeRemoved = trinketType, trinket1 = trinket1, trinket2 = trinket2, numSmeltedTrinkets = numSmeltedTrinkets}
+    return {trinketTypeRemoved = trinketType, trinketType1 = trinketType1, trinketType2 = trinketType2, numSmeltedTrinkets = numSmeltedTrinkets}
 end
 function ____exports.temporarilyRemoveTrinkets(self, player)
-    local trinket1 = player:GetTrinket(0)
-    local trinket2 = player:GetTrinket(1)
-    if trinket1 == TrinketType.TRINKET_NULL and trinket2 == TrinketType.TRINKET_NULL then
+    local trinketType1 = player:GetTrinket(0)
+    local trinketType2 = player:GetTrinket(1)
+    if trinketType1 == TrinketType.TRINKET_NULL and trinketType2 == TrinketType.TRINKET_NULL then
         return nil
     end
-    if trinket1 ~= TrinketType.TRINKET_NULL then
-        player:TryRemoveTrinket(trinket1)
+    if trinketType1 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinketType1)
     end
-    if trinket2 ~= TrinketType.TRINKET_NULL then
-        player:TryRemoveTrinket(trinket2)
+    if trinketType2 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinketType2)
     end
-    return {trinketTypeRemoved = TrinketType.TRINKET_NULL, trinket1 = trinket1, trinket2 = trinket2, numSmeltedTrinkets = 0}
+    return {trinketTypeRemoved = TrinketType.TRINKET_NULL, trinketType1 = trinketType1, trinketType2 = trinketType2, numSmeltedTrinkets = 0}
 end
 return ____exports

package/dist/functions/trinkets.lua

@@ -28,16 +28,16 @@ function ____exports.getMaxTrinketType(self)
 end
 function ____exports.getOpenTrinketSlot(self, player)
     local maxTrinkets = player:GetMaxTrinkets()
-    local trinket0 = player:GetTrinket(0)
-    local trinket1 = player:GetTrinket(1)
+    local trinketType1 = player:GetTrinket(0)
+    local trinketType2 = player:GetTrinket(1)
     if maxTrinkets == 1 then
-        return trinket0 == TrinketType.TRINKET_NULL and 0 or nil
+        return trinketType1 == TrinketType.TRINKET_NULL and 0 or nil
     end
     if maxTrinkets == 2 then
-        if trinket0 == TrinketType.TRINKET_NULL then
+        if trinketType1 == TrinketType.TRINKET_NULL then
             return 0
         end
-        return trinket1 == TrinketType.TRINKET_NULL and 1 or nil
+        return trinketType2 == TrinketType.TRINKET_NULL and 1 or nil
     end
     return error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
 end

package/dist/types/TrinketSituation.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
 export interface TrinketSituation {
     trinketTypeRemoved: TrinketType | int;
-    trinket1: TrinketType | int;
-    trinket2: TrinketType | int;
+    trinketType1: TrinketType | int;
+    trinketType2: TrinketType | int;
     numSmeltedTrinkets: int;
 }

package/package.json

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