isaacscript-common 6.4.0 → 6.5.0

package/functions/doors.lua

@@ -77,10 +77,13 @@ end
 function ____exports.isRepentanceDoor(self, door)
     return door.TargetRoomIndex == GridRoom.SECRET_EXIT
 end
+--- This refers to the hole in the wall that appears after bombing the entrance to a secret room.
+-- Note that the door still exists before it has been bombed open. It has a sprite filename of
+-- "gfx/grid/door_08_holeinwall.anm2".
 function ____exports.isSecretRoomDoor(self, door)
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_08_HoleInWall.anm2"
+    return filename == "gfx/grid/door_08_holeinwall.anm2"
 end
 --- Helper function to remove a single door.
 function ____exports.removeDoor(self, door)
@@ -234,54 +237,54 @@ function ____exports.isDoorSlotInRoomShape(self, doorSlot, roomShape)
     return doorSlots:has(doorSlot)
 end
 --- This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
--- to spend one key to open it. It has a sprite filename of "gfx/grid/Door_Downpour.anm2".
+-- to spend one key to open it. It has a sprite filename of "gfx/grid/door_downpour.anm2".
 function ____exports.isDoorToDownpour(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_Downpour.anm2"
+    return string.lower(filename) == "gfx/grid/door_downpour.anm2"
 end
 --- This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
--- to spend two hearts to open it. It has a sprite filename of "gfx/grid/Door_Mausoleum.anm2".
+-- to spend two hearts to open it. It has a sprite filename of "gfx/grid/door_mausoleum.anm2".
 function ____exports.isDoorToMausoleum(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_Mausoleum.anm2"
+    return string.lower(filename) == "gfx/grid/door_mausoleum.anm2"
 end
 --- This refers to the "strange door" located on the first room of Depths 2. You open it with either
--- a Polaroid or a Negative. It has a sprite filename of "gfx/grid/Door_Mausoleum_Alt.anm2".
+-- a Polaroid or a Negative. It has a sprite filename of "gfx/grid/door_mausoleum_alt.anm2".
 function ____exports.isDoorToMausoleumAscent(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_Mausoleum_Alt.anm2"
+    return string.lower(filename) == "gfx/grid/door_mausoleum_alt.anm2"
 end
 --- This refers to the Repentance door that spawns in a boss room after defeating the boss. You have
--- to spend two bombs to open it. It has a sprite filename of "gfx/grid/Door_Mines.anm2".
+-- to spend two bombs to open it. It has a sprite filename of "gfx/grid/door_mines.anm2".
 function ____exports.isDoorToMines(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_Mines.anm2"
+    return string.lower(filename) == "gfx/grid/door_mines.anm2"
 end
 --- This refers to the Repentance door that spawns after defeating Mom. You open it with the
--- completed knife. It has a sprite filename of "gfx/grid/Door_MomsHeart.anm2".
+-- completed knife. It has a sprite filename of "gfx/grid/door_momsheart.anm2".
 function ____exports.isDoorToMomsHeart(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
     end
     local sprite = door:GetSprite()
     local filename = sprite:GetFilename()
-    return filename == "gfx/grid/Door_MomsHeart.anm2"
+    return filename == "gfx/grid/door_momsheart.anm2"
 end
 function ____exports.isHiddenSecretRoomDoor(self, door)
     local sprite = door:GetSprite()

package/functions/gridEntity.d.ts

@@ -1,4 +1,5 @@
 import { GridEntityType, GridEntityXMLType } from "isaac-typescript-definitions";
+import { RockAltType } from "../enums/RockAltType";
 /**
  * Helper function to convert the grid entity type found in a room XML file to the corresponding
  * grid entity type and variant normally used by the game. For example, a rock is represented as
@@ -71,6 +72,21 @@ export declare function getGridEntityIDFromConstituents(gridEntityType: GridEnti
  * variant provided.
  */
 export declare function getMatchingGridEntities(gridEntityType: GridEntityType, variant: int): GridEntity[];
+/**
+ * Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
+ * will have.
+ *
+ * The rock type is based on the backdrop of the room.
+ *
+ * For example, if you change the backdrop of the starting room of the run to `BackdropType.CAVES`,
+ * and then spawn `GridEntityType.ROCK_ALT`, it will be a mushroom instead of an urn. Additionally,
+ * if it is destroyed, it will generate mushroom-appropriate rewards.
+ *
+ * On the other hand, if an urn is spawned first before the backdrop is changed to
+ * `BackdropType.CAVES`, the graphic of the urn will not switch to a mushroom. However, when
+ * destroyed, the urn will still generate mushroom-appropriate rewards.
+ */
+export declare function getRockAltType(): RockAltType;
 export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 export declare function getTopLeftWall(): GridEntity | undefined;
 /**
@@ -178,6 +194,24 @@ export declare function spawnGrid(gridEntityType: GridEntityType, gridIndexOrPos
  * - allows you to specify the grid index or the position
  */
 export declare function spawnGridWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int | Vector): GridEntity | undefined;
+/**
+ * Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
+ * breaks.
+ *
+ * Note that most of the time, this function will do nothing, similar to how most of the time, when
+ * an individual urn is destroyed, nothing will spawn.
+ *
+ * The logic in this function is based on the rewards listed on the wiki:
+ * https://bindingofisaacrebirth.fandom.com/wiki/Rocks
+ *
+ * @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
+ *                    at spawning coins and spiders.
+ * @param _seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
+ *                   the `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally,
+ *                   you should pass the `InitSeed` of the grid entity that was broken.
+ * @returns Whether or not this function spawned something.
+ */
+export declare function spawnRockAltReward(rockAltType: RockAltType, _seedOrRNG?: Seed | RNG): boolean;
 /**
  * Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
  * with the appropriate variant, as the game does not give it the correct sprite automatically.

package/functions/gridEntity.lua

@@ -15,6 +15,8 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constants = require("constants")
 local DISTANCE_OF_GRID_TILE = ____constants.DISTANCE_OF_GRID_TILE
+local ____RockAltType = require("enums.RockAltType")
+local RockAltType = ____RockAltType.RockAltType
 local ____gridEntityTypeToBrokenStateMap = require("maps.gridEntityTypeToBrokenStateMap")
 local GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP = ____gridEntityTypeToBrokenStateMap.GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP
 local ____gridEntityXMLMap = require("maps.gridEntityXMLMap")
@@ -22,8 +24,12 @@ local GRID_ENTITY_XML_MAP = ____gridEntityXMLMap.GRID_ENTITY_XML_MAP
 local ____roomShapeToTopLeftWallGridIndexMap = require("maps.roomShapeToTopLeftWallGridIndexMap")
 local DEFAULT_TOP_LEFT_WALL_GRID_INDEX = ____roomShapeToTopLeftWallGridIndexMap.DEFAULT_TOP_LEFT_WALL_GRID_INDEX
 local ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = ____roomShapeToTopLeftWallGridIndexMap.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP
+local ____backdropTypeToRockAltType = require("objects.backdropTypeToRockAltType")
+local BACKDROP_TYPE_TO_ROCK_ALT_TYPE = ____backdropTypeToRockAltType.BACKDROP_TYPE_TO_ROCK_ALT_TYPE
 local ____math = require("functions.math")
 local isCircleIntersectingRectangle = ____math.isCircleIntersectingRectangle
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
 local ____rooms = require("functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
 local ____sprite = require("functions.sprite")
@@ -255,6 +261,23 @@ function ____exports.getMatchingGridEntities(self, gridEntityType, variant)
         function(____, gridEntity) return gridEntity:GetVariant() == variant end
     )
 end
+--- Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
+-- will have.
+-- 
+-- The rock type is based on the backdrop of the room.
+-- 
+-- For example, if you change the backdrop of the starting room of the run to `BackdropType.CAVES`,
+-- and then spawn `GridEntityType.ROCK_ALT`, it will be a mushroom instead of an urn. Additionally,
+-- if it is destroyed, it will generate mushroom-appropriate rewards.
+-- 
+-- On the other hand, if an urn is spawned first before the backdrop is changed to
+-- `BackdropType.CAVES`, the graphic of the urn will not switch to a mushroom. However, when
+-- destroyed, the urn will still generate mushroom-appropriate rewards.
+function ____exports.getRockAltType(self)
+    local room = game:GetRoom()
+    local backdropType = room:GetBackdropType()
+    return BACKDROP_TYPE_TO_ROCK_ALT_TYPE[backdropType]
+end
 function ____exports.getSurroundingGridEntities(self, gridEntity)
     local room = game:GetRoom()
     local gridWidth = room:GetGridWidth()
@@ -400,6 +423,59 @@ end
 function ____exports.spawnGrid(self, gridEntityType, gridIndexOrPosition)
     return ____exports.spawnGridWithVariant(nil, gridEntityType, 0, gridIndexOrPosition)
 end
+--- Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
+-- breaks.
+-- 
+-- Note that most of the time, this function will do nothing, similar to how most of the time, when
+-- an individual urn is destroyed, nothing will spawn.
+-- 
+-- The logic in this function is based on the rewards listed on the wiki:
+-- https://bindingofisaacrebirth.fandom.com/wiki/Rocks
+-- 
+-- @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
+-- at spawning coins and spiders.
+-- @param _seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
+-- the `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally,
+-- you should pass the `InitSeed` of the grid entity that was broken.
+-- @returns Whether or not this function spawned something.
+function ____exports.spawnRockAltReward(self, rockAltType, _seedOrRNG)
+    if _seedOrRNG == nil then
+        _seedOrRNG = getRandomSeed(nil)
+    end
+    repeat
+        local ____switch56 = rockAltType
+        local ____cond56 = ____switch56 == RockAltType.URN
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+        ____cond56 = ____cond56 or ____switch56 == RockAltType.MUSHROOM
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+        ____cond56 = ____cond56 or ____switch56 == RockAltType.SKULL
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+        ____cond56 = ____cond56 or ____switch56 == RockAltType.POLYP
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+        ____cond56 = ____cond56 or ____switch56 == RockAltType.BUCKET
+        if ____cond56 then
+            do
+                return false
+            end
+        end
+    until true
+end
 --- Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
 -- with the appropriate variant, as the game does not give it the correct sprite automatically.
 function ____exports.spawnVoidPortal(self, gridIndex)

package/functions/pickups.d.ts

@@ -1,29 +1,29 @@
 import { BatterySubType, Card, CoinSubType, CollectibleType, HeartSubType, KeySubType, PillColor, SackSubType, TrinketType } from "isaac-typescript-definitions";
 /** Helper function to get all of the battery entities in the room. */
-export declare function getBatteries(matchingSubType?: number): EntityPickupBattery[];
+export declare function getBatteries(matchingSubType?: BatterySubType | -1): EntityPickupBattery[];
 /** Helper function to get all of the card entities in the room. */
-export declare function getCards(matchingSubType?: number): EntityPickupCard[];
+export declare function getCards(matchingSubType?: Card | -1): EntityPickupCard[];
 /**
  * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
  * sub-types.
  */
 export declare function getCoinValue(coinSubType: CoinSubType): int;
 /** Helper function to get all of the coin pickup entities in the room. */
-export declare function getCoins(matchingSubType?: number): EntityPickupCoin[];
+export declare function getCoins(matchingSubType?: CoinSubType | -1): EntityPickupCoin[];
 /** Helper function to get all of the collectible entities in the room. */
-export declare function getCollectibles(matchingSubType?: number): EntityPickupCollectible[];
+export declare function getCollectibles(matchingSubType?: CollectibleType | -1): EntityPickupCollectible[];
 /** Helper function to get all of the heart pickup entities in the room. */
-export declare function getHearts(matchingSubType?: number): EntityPickupHeart[];
+export declare function getHearts(matchingSubType?: HeartSubType | -1): EntityPickupHeart[];
 /** Helper function to get all of the key pickup entities in the room. */
-export declare function getKeys(matchingSubType?: number): EntityPickupKey[];
+export declare function getKeys(matchingSubType?: KeySubType | -1): EntityPickupKey[];
 /** Helper function to get all of the pill entities in the room. */
-export declare function getPills(matchingSubType?: number): EntityPickupPill[];
+export declare function getPills(matchingSubType?: PillColor | -1): EntityPickupPill[];
 /** Helper function to get all of the red heart pickup entities in the room. */
 export declare function getRedHearts(): EntityPickupHeart[];
 /** Helper function to get all of the sack (i.e. grab bag) entities in the room. */
-export declare function getSacks(matchingSubType?: number): EntityPickupSack[];
+export declare function getSacks(matchingSubType?: SackSubType | -1): EntityPickupSack[];
 /** Helper function to get all of the trinket entities in the room. */
-export declare function getTrinkets(matchingSubType?: number): EntityPickupTrinket[];
+export declare function getTrinkets(matchingSubType?: TrinketType | -1): EntityPickupTrinket[];
 export declare function isChest(pickup: EntityPickup): boolean;
 export declare function isRedHeart(pickup: EntityPickup): boolean;
 /**

package/functions/run.d.ts

@@ -13,3 +13,10 @@ export declare function onSetSeed(): boolean;
  * You can optionally specify a `PlayerType` to restart the game as that character.
  */
 export declare function restart(character?: PlayerType): void;
+/**
+ * Helper function to change the run status to that of an unseeded run with a new random seed.
+ *
+ * This is useful to revert the behavior where playing on a set and restarting the game will not
+ * take you to a new seed.
+ */
+export declare function setUnseeded(): void;

package/functions/run.lua

@@ -1,6 +1,7 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local Challenge = ____isaac_2Dtypescript_2Ddefinitions.Challenge
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constantsFirstLast = require("constantsFirstLast")
@@ -23,14 +24,25 @@ end
 -- You can optionally specify a `PlayerType` to restart the game as that character.
 function ____exports.restart(self, character)
     if character == nil then
-        log("Restarting.")
-        Isaac.ExecuteCommand("restart")
+        local command = "restart"
+        log("Restarting the run with a console command of: " .. command)
+        Isaac.ExecuteCommand(command)
         return
     end
     if character < FIRST_CHARACTER then
         error(("Restarting as a character of " .. tostring(character)) .. " would crash the game.")
     end
-    log("Restarting as character: " .. tostring(character))
-    Isaac.ExecuteCommand("restart " .. tostring(character))
+    local command = "restart " .. tostring(character)
+    log((((("Restarting the run as PlayerType." .. tostring(PlayerType[character])) .. " (") .. tostring(character)) .. ") with a console command of: ") .. command)
+    Isaac.ExecuteCommand(command)
+end
+--- Helper function to change the run status to that of an unseeded run with a new random seed.
+-- 
+-- This is useful to revert the behavior where playing on a set and restarting the game will not
+-- take you to a new seed.
+function ____exports.setUnseeded(self)
+    local seeds = game:GetSeeds()
+    seeds:Reset()
+    seeds:Restart(Challenge.NULL)
 end
 return ____exports