isaacscript-common 1.0.545 → 1.0.549

package/dist/functions/gridEntity.d.ts

@@ -90,7 +90,7 @@ export declare function removeGridEntity(gridEntity: GridEntity, updateRoom?: bo
  * Helper function to make a grid entity invisible. This is accomplished by setting its sprite to
  * an empty/missing PNG file.
  *
- * For more information, see the documentation for the "EMPTY_PNG_FILENAME" constant.
+ * For more information, see the documentation for the `clearSprite()` helper function.
  */
 export declare function setGridEntityInvisible(gridEntity: GridEntity): void;
 export declare function spawnGiantPoop(topLeftGridIndex: int): void;

package/dist/functions/gridEntity.lua

@@ -1,8 +1,6 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 require("lualib_bundle");
 local ____exports = {}
-local ____constants = require("constants")
-local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
 local ____gridEntityXMLMap = require("maps.gridEntityXMLMap")
 local GRID_ENTITY_XML_MAP = ____gridEntityXMLMap.GRID_ENTITY_XML_MAP
 local ____roomShapeToTopLeftWallGridIndexMap = require("maps.roomShapeToTopLeftWallGridIndexMap")
@@ -10,6 +8,8 @@ local DEFAULT_TOP_LEFT_WALL_GRID_INDEX = ____roomShapeToTopLeftWallGridIndexMap.
 local ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = ____roomShapeToTopLeftWallGridIndexMap.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP
 local ____rooms = require("functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
+local ____sprite = require("functions.sprite")
+local clearSprite = ____sprite.clearSprite
 function ____exports.getTopLeftWallGridIndex(self)
     local game = Game()
     local room = game:GetRoom()
@@ -161,8 +161,7 @@ function ____exports.removeAllMatchingGridEntities(self, ...)
 end
 function ____exports.setGridEntityInvisible(self, gridEntity)
     local sprite = gridEntity:GetSprite()
-    sprite:ReplaceSpritesheet(0, EMPTY_PNG_PATH)
-    sprite:LoadGraphics()
+    clearSprite(nil, sprite)
 end
 function ____exports.spawnGiantPoop(self, topLeftGridIndex)
     local game = Game()

package/dist/functions/rooms.d.ts

@@ -7,6 +7,8 @@
 export declare function changeRoom(roomGridIndex: int): void;
 export declare function getAllRoomGridIndexes(): int[];
 export declare function getCurrentDimension(): Dimension;
+/** An alias to the `Level.GetCurrentRoomDesc()` method. */
+export declare function getCurrentRoomDescReadOnly(): RoomDescriptorReadOnly;
 export declare function getRoomData(): RoomConfig | undefined;
 /**
  * Helper function to get the type for the room from the XML/STB data. The room data type will
@@ -126,6 +128,11 @@ export declare function inCrawlspace(): boolean;
  * with the Death Certificate area.
  */
 export declare function inDeathCertificateArea(): boolean;
+/**
+ * Helper function to detect if the current room is a Treasure Room created when entering with a
+ * Devil's Crown trinket. Under the hood, this checks for the `RoomDescriptorFlag.DEVIL_TREASURE`
+ * flag.
+ */
 export declare function inDevilsCrownTreasureRoom(): boolean;
 export declare function inDimension(dimension: Dimension): boolean;
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
@@ -152,6 +159,11 @@ export declare function inStartingRoom(): boolean;
  * default.
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
+/**
+ * Helper function to detect if the current room was created by the Red Key item. Under the hood,
+ * this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.
+ */
+export declare function isRedKeyRoom(): boolean;
 /**
  * Helper function to determine whether or not the current room is part of the floor layout. For
  * example, Devil Rooms and the Mega Satan room are not considered to be inside the map.

package/dist/functions/rooms.lua

@@ -17,6 +17,11 @@ local setEntityPositions = ____entity.setEntityPositions
 local setEntityVelocities = ____entity.setEntityVelocities
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
+function ____exports.getCurrentRoomDescReadOnly(self)
+    local game = Game()
+    local level = game:GetLevel()
+    return level:GetCurrentRoomDesc()
+end
 function ____exports.getRoomData(self)
     local game = Game()
     local level = game:GetLevel()
@@ -25,9 +30,7 @@ function ____exports.getRoomData(self)
     return roomDesc.Data
 end
 function ____exports.getRoomSafeGridIndex(self)
-    local game = Game()
-    local level = game:GetLevel()
-    local roomDesc = level:GetCurrentRoomDesc()
+    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
     return roomDesc.SafeGridIndex
 end
 function ____exports.getRoomStageID(self)
@@ -130,9 +133,7 @@ function ____exports.getRoomDataType(self)
     return roomData.Type
 end
 function ____exports.getRoomListIndex(self)
-    local game = Game()
-    local level = game:GetLevel()
-    local roomDesc = level:GetCurrentRoomDesc()
+    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
     return roomDesc.ListIndex
 end
 function ____exports.getRoomGridIndexesForType(self, roomType)
@@ -169,9 +170,7 @@ function ____exports.getRoomVariant(self)
     return roomData.Variant
 end
 function ____exports.getRoomVisitedCount(self)
-    local game = Game()
-    local level = game:GetLevel()
-    local roomDesc = level:GetCurrentRoomDesc()
+    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
     return roomDesc.VisitedCount
 end
 function ____exports.gridToPos(self, x, y)
@@ -214,9 +213,7 @@ function ____exports.inCrawlspace(self)
     return (roomSafeGridIndex == GridRooms.ROOM_DUNGEON_IDX) and (roomSubType ~= 4)
 end
 function ____exports.inDevilsCrownTreasureRoom(self)
-    local game = Game()
-    local level = game:GetLevel()
-    local roomDesc = level:GetCurrentRoomDesc()
+    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
     return hasFlag(nil, roomDesc.Flags, 2048)
 end
 function ____exports.inDimension(self, dimension)
@@ -259,20 +256,24 @@ function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
         do
             local roomData = roomDesc.Data
             if roomData == nil then
-                goto __continue48
+                goto __continue49
             end
             local roomType = roomData.Type
             if (roomTypeWhitelist ~= nil) and (not roomTypeWhitelist:has(roomType)) then
-                goto __continue48
+                goto __continue49
             end
             if not roomDesc.Clear then
                 return false
             end
         end
-        ::__continue48::
+        ::__continue49::
     end
     return true
 end
+function ____exports.isRedKeyRoom(self)
+    local roomDesc = ____exports.getCurrentRoomDescReadOnly(nil)
+    return hasFlag(nil, roomDesc.Flags, 1024)
+end
 function ____exports.isRoomInsideMap(self)
     local roomSafeGridIndex = ____exports.getRoomSafeGridIndex(nil)
     return roomSafeGridIndex >= 0
@@ -301,14 +302,14 @@ function ____exports.setRoomCleared(self)
     ) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue56
+                goto __continue58
             end
             door.State = DoorState.STATE_OPEN
             local sprite = door:GetSprite()
             sprite:Play("Opened", true)
             door.ExtraVisible = false
         end
-        ::__continue56::
+        ::__continue58::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/seeds.d.ts

@@ -1,2 +1,2 @@
-/** Helper function to get the seed of the current run. */
+/** Alias for the `Seeds.GetStartSeedString` method. */
 export declare function getStartSeedString(): string;

package/dist/functions/sprite.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to clear a specific layer from a sprite. This function is variadic, so pass as
- * many layer IDs as you want to clear.
+ * many layer IDs as you want to clear. If no specific layers are passed, it will clear every layer.
  *
  * Since there is no official API method to "clear" a sprite, we can work around it by setting the
  * spritesheet to a non-existent or completely transparent file. If the path to the spritesheet does

package/dist/functions/sprite.lua

@@ -1,9 +1,21 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+require("lualib_bundle");
 local ____exports = {}
 local ____constants = require("constants")
 local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
 function ____exports.clearSprite(self, sprite, ...)
     local layerIDs = {...}
+    local numLayers = sprite:GetLayerCount()
+    if #layerIDs == 0 then
+        layerIDs = {}
+        do
+            local i = 0
+            while i < numLayers do
+                __TS__ArrayPush(layerIDs, i)
+                i = i + 1
+            end
+        end
+    end
     for ____, layerID in ipairs(layerIDs) do
         sprite:ReplaceSpritesheet(layerID, EMPTY_PNG_PATH)
     end

package/dist/functions/stage.d.ts

@@ -5,9 +5,9 @@
  * consider Downpour 2 to have a stage of 3.
  */
 export declare function getEffectiveStage(): int;
-/** Helper function to get the current stage. */
+/** Alias for the `Level.GetStage` method. */
 export declare function getStage(): LevelStage;
-/** Helper function to get the current stage type. */
+/** Alias for the `Level.GetStageType` method. */
 export declare function getStageType(): StageType;
 /** Helper function to directly warp to a specific stage using the "stage" console command. */
 export declare function goToStage(stage: LevelStage, stageType: StageType): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.545",
+  "version": "1.0.549",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.306",
+    "isaac-typescript-definitions": "^1.0.307",
     "isaacscript-lint": "^1.0.73",
     "typedoc": "^0.22.10",
     "typescript": "4.4.4",