isaacscript-common 1.2.173 → 1.2.176

package/dist/functions/playerHealth.lua

@@ -14,26 +14,6 @@ local getSoulHearts = ____player.getSoulHearts
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 local ____repeat = ____utils["repeat"]
-function ____exports.removeAllPlayerHealth(self, player)
-    local character = player:GetPlayerType()
-    local goldenHearts = player:GetGoldenHearts()
-    local eternalHearts = player:GetEternalHearts()
-    local boneHearts = player:GetBoneHearts()
-    local brokenHearts = player:GetBrokenHearts()
-    player:AddGoldenHearts(goldenHearts * -1)
-    player:AddEternalHearts(eternalHearts * -1)
-    player:AddBoneHearts(boneHearts * -1)
-    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
-        local forgotten = player:GetSubPlayer()
-        if forgotten ~= nil then
-            local forgottenBoneHearts = forgotten:GetBoneHearts()
-            forgotten:AddBoneHearts(forgottenBoneHearts * -1)
-        end
-    end
-end
 function ____exports.addPlayerHealthType(self, player, healthType, numHearts)
     repeat
         local ____switch3 = healthType
@@ -233,6 +213,26 @@ function ____exports.getPlayerHealthType(self, player, healthType)
         end
     until true
 end
+function ____exports.removeAllPlayerHealth(self, player)
+    local character = player:GetPlayerType()
+    local goldenHearts = player:GetGoldenHearts()
+    local eternalHearts = player:GetEternalHearts()
+    local boneHearts = player:GetBoneHearts()
+    local brokenHearts = player:GetBrokenHearts()
+    player:AddGoldenHearts(goldenHearts * -1)
+    player:AddEternalHearts(eternalHearts * -1)
+    player:AddBoneHearts(boneHearts * -1)
+    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
+        local forgotten = player:GetSubPlayer()
+        if forgotten ~= nil then
+            local forgottenBoneHearts = forgotten:GetBoneHearts()
+            forgotten:AddBoneHearts(forgottenBoneHearts * -1)
+        end
+    end
+end
 function ____exports.setPlayerHealth(self, player, playerHealth)
     local character = player:GetPlayerType()
     local subPlayer = player:GetSubPlayer()

package/dist/functions/positionVelocity.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
+export declare function anyEntityCloserThan(entities: Entity[], position: Vector, distance: int): boolean;
+/** Iterates over all players and checks if any player is close enough to the specified position. */
+export declare function anyPlayerCloserThan(position: Vector, distance: float): boolean;
 /**
  * Helper function to get a room position that is not overlapping with a grid entity, a heaven door,
  * or a player. The `Room.FindFreePickupSpawnPosition` method will return locations that overlap

package/dist/functions/positionVelocity.lua

@@ -1,5 +1,6 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
+local __TS__ArraySome = ____lualib.__TS__ArraySome
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
@@ -8,13 +9,26 @@ local game = ____cachedClasses.game
 local ____constants = require("constants")
 local DISTANCE_OF_GRID_TILE = ____constants.DISTANCE_OF_GRID_TILE
 local ____entity = require("functions.entity")
-local anyEntityCloserThan = ____entity.anyEntityCloserThan
 local getEntities = ____entity.getEntities
 local ____entitySpecific = require("functions.entitySpecific")
 local getEffects = ____entitySpecific.getEffects
 local ____player = require("functions.player")
 local getPlayerCloserThan = ____player.getPlayerCloserThan
+local getPlayers = ____player.getPlayers
 local MAX_FIND_FREE_POSITION_ATTEMPTS = 100
+function ____exports.anyEntityCloserThan(self, entities, position, distance)
+    return __TS__ArraySome(
+        entities,
+        function(____, entity) return position:Distance(entity.Position) <= distance end
+    )
+end
+function ____exports.anyPlayerCloserThan(self, position, distance)
+    local players = getPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player) return player.Position:Distance(position) <= distance end
+    )
+end
 function ____exports.findFreePosition(self, startingPosition, avoidActiveEntities)
     if avoidActiveEntities == nil then
         avoidActiveEntities = false
@@ -28,15 +42,15 @@ function ____exports.findFreePosition(self, startingPosition, avoidActiveEntitie
                 local position = room:FindFreePickupSpawnPosition(startingPosition, i, avoidActiveEntities)
                 local closePlayer = getPlayerCloserThan(nil, position, DISTANCE_OF_GRID_TILE)
                 if closePlayer ~= nil then
-                    goto __continue3
+                    goto __continue7
                 end
-                local isCloseHeavenDoor = anyEntityCloserThan(nil, heavenDoors, position, DISTANCE_OF_GRID_TILE)
+                local isCloseHeavenDoor = ____exports.anyEntityCloserThan(nil, heavenDoors, position, DISTANCE_OF_GRID_TILE)
                 if isCloseHeavenDoor then
-                    goto __continue3
+                    goto __continue7
                 end
                 return position
             end
-            ::__continue3::
+            ::__continue7::
             i = i + 1
         end
     end

package/dist/functions/random.d.ts

@@ -25,13 +25,6 @@ export declare function getRandomFloat(min: int, max: int, seed?: Seed): float;
  * ```
  */
 export declare function getRandomInt(min: int, max: int, seed?: Seed): int;
-/**
- * Helper function to get the next seed value.
- *
- * This function is useful because it is standard practice to work with seed values directly over
- * RNG objects, since the latter are not serializable.
- */
-export declare function nextSeed(seed: Seed): Seed;
 /**
  * Helper function to initialize an RNG object.
  *
@@ -48,3 +41,10 @@ export declare function nextSeed(seed: Seed): Seed;
  * @param seed The seed to initialize it with. Default is `Random()`.
  */
 export declare function initRNG(seed?: Seed): RNG;
+/**
+ * Helper function to get the next seed value.
+ *
+ * This function is useful because it is standard practice to work with seed values directly over
+ * RNG objects, since the latter are not serializable.
+ */
+export declare function nextSeed(seed: Seed): Seed;

package/dist/functions/revive.d.ts

@@ -4,11 +4,6 @@
  * will be fatal.
  */
 export declare function isDamageToPlayerFatal(player: EntityPlayer, damageAmount: int, damageSource: EntityRef, lastDamageGameFrame: int | undefined): boolean;
-/**
- * The `EntityPlayer.WillPlayerRevive` method does not properly account for Mysterious Paper, so use
- * this helper function instead for more robust revival detection.
- */
-export declare function willPlayerRevive(player: EntityPlayer): boolean;
 /**
  * Assuming that we are on the frame of fatal damage, this function returns whether or not
  * Mysterious Paper would rotate to Missing Poster on the frame that the "Game Over" screen would
@@ -18,6 +13,11 @@ export declare function willPlayerRevive(player: EntityPlayer): boolean;
  * Mysterious Paper be Missing Power is: `gameFrameCount % 4 === 3`
  */
 export declare function willMysteriousPaperRevive(player: EntityPlayer): boolean;
+/**
+ * The `EntityPlayer.WillPlayerRevive` method does not properly account for Mysterious Paper, so use
+ * this helper function instead for more robust revival detection.
+ */
+export declare function willPlayerRevive(player: EntityPlayer): boolean;
 /**
  * Helper function to determine if the player will be revived by the Heartbreak collectible if they
  * take fatal damage. This is contingent on the character that they are playing as and the amount of

package/dist/functions/revive.lua

@@ -13,14 +13,6 @@ local getFinalFrameOfAnimation = ____sprite.getFinalFrameOfAnimation
 local ____trinketGive = require("functions.trinketGive")
 local giveTrinketsBack = ____trinketGive.giveTrinketsBack
 local temporarilyRemoveTrinket = ____trinketGive.temporarilyRemoveTrinket
-function ____exports.willMysteriousPaperRevive(self, player)
-    local gameFrameCount = game:GetFrameCount()
-    local sprite = player:GetSprite()
-    local animation = getDeathAnimationName(nil, player)
-    local deathAnimationFrames = getFinalFrameOfAnimation(nil, sprite, animation)
-    local frameOfDeath = gameFrameCount + deathAnimationFrames + 1
-    return frameOfDeath % 4 == 3
-end
 function ____exports.willReviveFromHeartbreak(self, player)
     if not player:HasCollectible(CollectibleType.COLLECTIBLE_HEARTBREAK) then
         return false
@@ -79,6 +71,14 @@ function ____exports.isDamageToPlayerFatal(self, player, damageAmount, damageSou
     end
     return true
 end
+function ____exports.willMysteriousPaperRevive(self, player)
+    local gameFrameCount = game:GetFrameCount()
+    local sprite = player:GetSprite()
+    local animation = getDeathAnimationName(nil, player)
+    local deathAnimationFrames = getFinalFrameOfAnimation(nil, sprite, animation)
+    local frameOfDeath = gameFrameCount + deathAnimationFrames + 1
+    return frameOfDeath % 4 == 3
+end
 function ____exports.willPlayerRevive(self, player)
     local trinketSituation = temporarilyRemoveTrinket(nil, player, TrinketType.TRINKET_MYSTERIOUS_PAPER)
     local willRevive = player:WillPlayerRevive() or trinketSituation ~= nil and ____exports.willMysteriousPaperRevive(nil, player)

package/dist/functions/roomData.d.ts

@@ -0,0 +1,96 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
+ * `RoomDescriptor` object that you are retrieving.
+ */
+export declare function getCurrentRoomDescriptorReadOnly(): RoomDescriptorReadOnly;
+/**
+ * Helper function to get the room data for the provided room.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export declare function getRoomData(roomGridIndex?: int): RoomConfig | undefined;
+/**
+ * Helper function to get the descriptor for a room.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
+/**
+ * Helper function to get the grid index of the current room.
+ *
+ * - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
+ *   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
+ *   overlaps with, or the top-right 1x1 section of a `RoomType.ROOMSHAPE_LTL` room.)
+ * - If the current room is outside of the grid, it will return the index from the
+ *   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases).
+ *
+ * Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
+ * will return the specific 1x1 quadrant that the player entered the room at. For most situations,
+ * using the safe grid index is more reliable than this.
+ *
+ * Data structures that store data per room should use the room's `ListIndex` instead of
+ * `SafeGridIndex`, since the former is unique across different dimensions.
+ */
+export declare function getRoomGridIndex(): int;
+/**
+ * Helper function to get the list grid index of the provided room, which is equal to the index in
+ * the `RoomList.Get` method. In other words, this is equal to the order that the room was created
+ * by the floor generation algorithm.
+ *
+ * Use this as an index for data structures that store data per room, since it is unique across
+ * different dimensions.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export declare function getRoomListIndex(roomGridIndex?: int): int;
+/**
+ * Helper function to get the name of the room as it appears in the STB/XML data.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room name. Returns "Unknown" if the type was not found.
+ */
+export declare function getRoomName(roomGridIndex?: int): string;
+/**
+ * Helper function to get the stage ID for a room from the XML/STB data. The room stage ID will
+ * correspond to the first number in the filename of the XML/STB file. For example, a Depths room
+ * would have a stage ID of 7.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room stage ID. Returns -1 if the stage ID was not found.
+ */
+export declare function getRoomStageID(roomGridIndex?: int): StageID;
+/**
+ * Helper function to get the sub-type for a room from the XML/STB data. The room sub-type will
+ * correspond to different things depending on what XML/STB file it draws from. For example, in the
+ * "00.special rooms.stb" file, an Angel Room with a sub-type of 0 will correspond to a normal Angel
+ * Room and a sub-type of 1 will correspond to an Angel Room shop for The Stairway.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room sub-type. Returns -1 if the sub-type was not found.
+ */
+export declare function getRoomSubType(roomGridIndex?: int): int;
+/**
+ * Helper function for getting the type of the room with the given grid index.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room data type. Returns -1 if the type was not found.
+ */
+export declare function getRoomType(roomGridIndex?: int): RoomType;
+/**
+ * Helper function to get the variant for a room from the XML/STB data. You can think of a room
+ * variant as its identifier. For example, to go to Basement room #123, you would use a console
+ * command of `goto d.123` while on the Basement.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ * @returns The room variant. Returns -1 if the variant was not found.
+ */
+export declare function getRoomVariant(roomGridIndex?: int): int;
+/**
+ * Note that the room visited count will be inaccurate during the period before the PostNewRoom
+ * callback has fired (i.e. when entities are initializing and performing their first update). This
+ * is because the variable is only incremented immediately before the PostNewRoom callback fires.
+ *
+ * @param roomGridIndex Optional. Default is the current room index.
+ */
+export declare function getRoomVisitedCount(roomGridIndex?: int): int;

package/dist/functions/roomData.lua

@@ -0,0 +1,57 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+function ____exports.getCurrentRoomDescriptorReadOnly(self)
+    local level = game:GetLevel()
+    return level:GetCurrentRoomDesc()
+end
+function ____exports.getRoomDescriptor(self, roomGridIndex)
+    local level = game:GetLevel()
+    if roomGridIndex == nil then
+        roomGridIndex = ____exports.getRoomGridIndex(nil)
+    end
+    return level:GetRoomByIdx(roomGridIndex)
+end
+function ____exports.getRoomGridIndex(self)
+    local level = game:GetLevel()
+    local currentRoomIndex = level:GetCurrentRoomIndex()
+    if currentRoomIndex < 0 then
+        return currentRoomIndex
+    end
+    local roomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
+    return roomDescriptor.SafeGridIndex
+end
+function ____exports.getRoomData(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.Data
+end
+function ____exports.getRoomListIndex(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.ListIndex
+end
+function ____exports.getRoomName(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and "Unknown" or roomData.Name
+end
+function ____exports.getRoomStageID(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and -1 or roomData.StageID
+end
+function ____exports.getRoomSubType(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and -1 or roomData.Subtype
+end
+function ____exports.getRoomType(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and -1 or roomData.Type
+end
+function ____exports.getRoomVariant(self, roomGridIndex)
+    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    return roomData == nil and -1 or roomData.Variant
+end
+function ____exports.getRoomVisitedCount(self, roomGridIndex)
+    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    return roomDescriptor.VisitedCount
+end
+return ____exports

package/dist/functions/rooms.d.ts

@@ -15,47 +15,6 @@ export declare function getAllRoomGridIndexes(): int[];
  * tricky to properly detect.
  */
 export declare function getCurrentDimension(): Dimension;
-/**
- * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
- * `RoomDescriptor` object that you are retrieving.
- */
-export declare function getCurrentRoomDescriptorReadOnly(): RoomDescriptorReadOnly;
-/**
- * Helper function to get the room data for the provided room.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- */
-export declare function getRoomData(roomGridIndex?: int): RoomConfig | undefined;
-/**
- * Helper function for getting the type of the room with the given grid index.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room data type. Returns -1 if the type was not found.
- */
-export declare function getRoomType(roomGridIndex?: int): RoomType;
-/**
- * Helper function to get the descriptor for a room.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- */
-export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
-/**
- * Helper function to get the grid index of the current room.
- *
- * - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
- *   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
- *   overlaps with, or the top-right 1x1 section of a `RoomType.ROOMSHAPE_LTL` room.)
- * - If the current room is outside of the grid, it will return the index from the
- *   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases).
- *
- * Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
- * will return the specific 1x1 quadrant that the player entered the room at. For most situations,
- * using the safe grid index is more reliable than this.
- *
- * Data structures that store data per room should use the room's `ListIndex` instead of
- * `SafeGridIndex`, since the former is unique across different dimensions.
- */
-export declare function getRoomGridIndex(): int;
 /**
  * Helper function to get an array of all of the safe grid indexes for rooms that match the
  * specified room type.
@@ -71,60 +30,6 @@ export declare function getRoomGridIndexesForType(...roomTypes: RoomType[]): int
  * `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room.
  */
 export declare function getRoomItemPoolType(): ItemPoolType;
-/**
- * Helper function to get the list grid index of the provided room, which is equal to the index in
- * the `RoomList.Get` method. In other words, this is equal to the order that the room was created
- * by the floor generation algorithm.
- *
- * Use this as an index for data structures that store data per room, since it is unique across
- * different dimensions.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- */
-export declare function getRoomListIndex(roomGridIndex?: int): int;
-/**
- * Helper function to get the name of the room as it appears in the STB/XML data.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room name. Returns "Unknown" if the type was not found.
- */
-export declare function getRoomName(roomGridIndex?: int): string;
-/**
- * Helper function to get the stage ID for a room from the XML/STB data. The room stage ID will
- * correspond to the first number in the filename of the XML/STB file. For example, a Depths room
- * would have a stage ID of 7.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room stage ID. Returns -1 if the stage ID was not found.
- */
-export declare function getRoomStageID(roomGridIndex?: int): StageID;
-/**
- * Helper function to get the sub-type for a room from the XML/STB data. The room sub-type will
- * correspond to different things depending on what XML/STB file it draws from. For example, in the
- * "00.special rooms.stb" file, an Angel Room with a sub-type of 0 will correspond to a normal Angel
- * Room and a sub-type of 1 will correspond to an Angel Room shop for The Stairway.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room sub-type. Returns -1 if the sub-type was not found.
- */
-export declare function getRoomSubType(roomGridIndex?: int): int;
-/**
- * Helper function to get the variant for a room from the XML/STB data. You can think of a room
- * variant as its identifier. For example, to go to Basement room #123, you would use a console
- * command of `goto d.123` while on the Basement.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- * @returns The room variant. Returns -1 if the variant was not found.
- */
-export declare function getRoomVariant(roomGridIndex?: int): int;
-/**
- * Note that the room visited count will be inaccurate during the period before the PostNewRoom
- * callback has fired (i.e. when entities are initializing and performing their first update). This
- * is because the variable is only incremented immediately before the PostNewRoom callback fires.
- *
- * @param roomGridIndex Optional. Default is the current room index.
- */
-export declare function getRoomVisitedCount(roomGridIndex?: int): int;
 /**
  * Helper function to get the room descriptor for every room on the level. Uses the `Level.GetRooms`
  * method to accomplish this.
@@ -169,9 +74,9 @@ export declare function inDeathCertificateArea(): boolean;
  */
 export declare function inDevilsCrownTreasureRoom(): boolean;
 export declare function inDimension(dimension: Dimension): boolean;
+export declare function inGenesisRoom(): boolean;
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
 export declare function inLRoom(): boolean;
-export declare function inGenesisRoom(): boolean;
 export declare function inMegaSatanRoom(): boolean;
 /**
  * Helper function to check if the current room is a miniboss room for a particular miniboss. This