isaacscript-common 1.2.241 → 1.2.244

package/dist/callbacks/postNewRoomEarly.lua

@@ -5,7 +5,7 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____gridEntity = require("functions.gridEntity")
 local getTopLeftWallGridIndex = ____gridEntity.getTopLeftWallGridIndex
-local spawnGridEntity = ____gridEntity.spawnGridEntity
+local spawnGrid = ____gridEntity.spawnGrid
 local ____log = require("functions.log")
 local logError = ____log.logError
 local ____postNewRoomEarly = require("callbacks.subscriptions.postNewRoomEarly")
@@ -33,14 +33,14 @@ function checkRoomChanged(self)
     local topLeftWall = room:GetGridEntity(topLeftWallGridIndex)
     local topLeftWall2 = room:GetGridEntity(rightOfTopWallGridIndex)
     if topLeftWall == nil then
-        topLeftWall = spawnGridEntity(nil, GridEntityType.GRID_WALL, topLeftWallGridIndex)
+        topLeftWall = spawnGrid(nil, GridEntityType.GRID_WALL, topLeftWallGridIndex)
         if topLeftWall == nil then
             logError("Failed to spawn a new wall (1) for the PostNewRoomEarly callback.")
             return
         end
     end
     if topLeftWall2 == nil then
-        topLeftWall2 = spawnGridEntity(nil, GridEntityType.GRID_WALL, rightOfTopWallGridIndex)
+        topLeftWall2 = spawnGrid(nil, GridEntityType.GRID_WALL, rightOfTopWallGridIndex)
         if topLeftWall2 == nil then
             logError("Failed to spawn a new wall (2) for the PostNewRoomEarly callback.")
             return

package/dist/features/deployJSONRoom.lua

@@ -23,9 +23,9 @@ local removeAllPickups = ____entitySpecific.removeAllPickups
 local ____gridEntity = require("functions.gridEntity")
 local convertXMLGridEntityType = ____gridEntity.convertXMLGridEntityType
 local getGridEntities = ____gridEntity.getGridEntities
-local removeAllGridEntitiesExceptFor = ____gridEntity.removeAllGridEntitiesExceptFor
+local removeAllGridExcept = ____gridEntity.removeAllGridExcept
 local setGridEntityInvisible = ____gridEntity.setGridEntityInvisible
-local spawnGridEntityWithVariant = ____gridEntity.spawnGridEntityWithVariant
+local spawnGridWithVariant = ____gridEntity.spawnGridWithVariant
 local ____jsonRoom = require("functions.jsonRoom")
 local getRandomJSONRoom = ____jsonRoom.getRandomJSONRoom
 local ____log = require("functions.log")
@@ -91,7 +91,7 @@ function ____exports.emptyRoom(self, fillWithDecorations)
     removeSpecificNPCs(nil)
     removeAllMatchingEntities(nil, EntityType.ENTITY_EFFECT, EffectVariant.DEVIL)
     removeAllMatchingEntities(nil, EntityType.ENTITY_EFFECT, EffectVariant.ANGEL)
-    removeAllGridEntitiesExceptFor(nil, GridEntityType.GRID_WALL, GridEntityType.GRID_DOOR)
+    removeAllGridExcept(nil, GridEntityType.GRID_WALL, GridEntityType.GRID_DOOR)
     setRoomCleared(nil)
     if fillWithDecorations then
         fillRoomWithDecorations(nil)
@@ -221,7 +221,7 @@ function spawnGridEntityForJSONRoom(self, xmlEntityType, xmlEntityVariant, x, y)
     local gridEntityType, variant = table.unpack(gridEntityTuple)
     local position = gridCoordinatesToWorldPosition(nil, x, y)
     local gridIndex = room:GetGridIndex(position)
-    local gridEntity = spawnGridEntityWithVariant(nil, gridEntityType, variant, gridIndex)
+    local gridEntity = spawnGridWithVariant(nil, gridEntityType, variant, gridIndex)
     if gridEntity == nil then
         return gridEntity
     end

package/dist/features/extraConsoleCommands/commands.lua

@@ -19,7 +19,7 @@ local getCharacterName = ____character.getCharacterName
 local ____entitySpecific = require("functions.entitySpecific")
 local getNPCs = ____entitySpecific.getNPCs
 local ____gridEntity = require("functions.gridEntity")
-local spawnGridEntityWithVariant = ____gridEntity.spawnGridEntityWithVariant
+local spawnGridWithVariant = ____gridEntity.spawnGridWithVariant
 local ____log = require("functions.log")
 local logEffects = ____log.logEffects
 local logEntities = ____log.logEntities
@@ -195,7 +195,7 @@ function spawnTrapdoorOrCrawlspace(self, trapdoor)
     local position = room:FindFreeTilePosition(player.Position, 0)
     local gridIndex = room:GetGridIndex(position)
     local gridEntityType = trapdoor and GridEntityType.GRID_TRAPDOOR or GridEntityType.GRID_STAIRS
-    spawnGridEntityWithVariant(nil, gridEntityType, 0, gridIndex)
+    spawnGridWithVariant(nil, gridEntityType, 0, gridIndex)
 end
 function warpToRoomType(self, roomType)
     local roomTypeName = ROOM_TYPE_NAMES[roomType]

package/dist/functions/array.lua

@@ -203,8 +203,7 @@ end
 function ____exports.sumArray(self, array)
     return __TS__ArrayReduce(
         array,
-        function(____, accumulator, element) return accumulator + element end,
-        0
+        function(____, accumulator, element) return accumulator + element end
     )
 end
 return ____exports

package/dist/functions/benchmark.lua

@@ -24,7 +24,7 @@ function ____exports.benchmark(self, numTrials, ...)
                 end
             end
             local averageTimeMilliseconds = totalTimeMilliseconds / numTrials
-            log(((("The average time of function " .. tostring(i)) .. " is: ") .. tostring(averageTimeMilliseconds)) .. " milliseconds")
+            log(((("The average time of the function at index " .. tostring(i)) .. " is: ") .. tostring(averageTimeMilliseconds)) .. " milliseconds")
             __TS__ArrayPush(averages, averageTimeMilliseconds)
         end
     )

package/dist/functions/debug.lua

@@ -1,5 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____log = require("functions.log")
+local log = ____log.log
 function ____exports.getTraceback(self)
     if debug ~= nil then
         return debug.traceback()
@@ -11,6 +13,15 @@ function ____exports.getTraceback(self)
 end
 function ____exports.traceback(self)
     local tracebackOutput = ____exports.getTraceback(nil)
-    Isaac.DebugString(tracebackOutput)
+    log(tracebackOutput)
 end
+local function setDebugFunctionsGlobal(self)
+    if debug == nil then
+        return
+    end
+    local globals = _G
+    globals.getTraceback = ____exports.getTraceback
+    globals.traceback = ____exports.traceback
+end
+setDebugFunctionsGlobal(nil)
 return ____exports

package/dist/functions/gridEntity.d.ts

@@ -85,7 +85,7 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  *
  * @returns True if one or more grid entities were removed, false otherwise.
  */
-export declare function removeAllGridEntitiesExceptFor(...gridEntityTypes: GridEntityType[]): boolean;
+export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]): boolean;
 /**
  * Helper function to remove all of the grid entities in the room that match the grid entity types
  * provided.
@@ -112,7 +112,7 @@ export declare function removeAllMatchingGridEntities(...gridEntityType: GridEnt
  * this is expensive, since it involves a call to `Isaac.GetRoomEntities`, so set it to false if you
  * need to invoke this function multiple times.
  */
-export declare function removeGridEntity(gridEntity: GridEntity, updateRoom?: boolean): void;
+export declare function removeGrid(gridEntity: GridEntity, updateRoom?: boolean): void;
 /**
  * Helper function to make a grid entity invisible. This is accomplished by setting its sprite to
  * an empty/missing PNG file.
@@ -129,23 +129,23 @@ export declare function spawnGiantPoop(topLeftGridIndex: int): void;
  * Helper function to spawn a grid entity.
  *
  * This function assumes you want to give the grid entity a variant of 0. If you want to specify a
- * variant, use the `spawnGridEntityWithVariant` helper function instead.
+ * variant, use the `spawnGridWithVariant` helper function instead.
  *
  * Use this instead of the `Isaac.GridSpawn` method since it:
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
- * - allows you to specify the grid index instead of the position
+ * - allows you to specify either the grid index or the position
  */
-export declare function spawnGridEntity(gridEntityType: GridEntityType, gridIndex: int): GridEntity | undefined;
+export declare function spawnGrid(gridEntityType: GridEntityType, gridIndexOrPosition: int): GridEntity | undefined;
 /**
  * Helper function to spawn a grid entity with a specific variant.
  *
  * Use this instead of the `Isaac.GridSpawn` method since it:
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
- * - allows you to specify the grid index instead of the position
+ * - allows you to specify the grid index or the position
  */
-export declare function spawnGridEntityWithVariant(gridEntityType: GridEntityType, variant: int, gridIndex: int): GridEntity | undefined;
+export declare function spawnGridWithVariant(gridEntityType: GridEntityType, variant: int, gridIndexOrPosition: int): GridEntity | undefined;
 /**
  * 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/dist/functions/gridEntity.lua

@@ -25,6 +25,8 @@ local ____rooms = require("functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
+local ____vector = require("functions.vector")
+local isVector = ____vector.isVector
 function getAllGridEntities(self)
     local room = game:GetRoom()
     local gridSize = room:GetGridSize()
@@ -43,7 +45,7 @@ function ____exports.getTopLeftWallGridIndex(self)
     local topLeftWallGridIndex = ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP:get(roomShape)
     return topLeftWallGridIndex == nil and DEFAULT_TOP_LEFT_WALL_GRID_INDEX or topLeftWallGridIndex
 end
-function ____exports.removeGridEntity(self, gridEntity, updateRoom)
+function ____exports.removeGrid(self, gridEntity, updateRoom)
     if updateRoom == nil then
         updateRoom = true
     end
@@ -54,13 +56,19 @@ function ____exports.removeGridEntity(self, gridEntity, updateRoom)
         roomUpdateSafe(nil)
     end
 end
-function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, gridIndex)
+function ____exports.spawnGridWithVariant(self, gridEntityType, variant, gridIndexOrPosition)
     local room = game:GetRoom()
-    local existingGridEntity = room:GetGridEntity(gridIndex)
+    local ____isVector_result_0
+    if isVector(nil, gridIndexOrPosition) then
+        ____isVector_result_0 = room:GetGridEntityFromPos(gridIndexOrPosition)
+    else
+        ____isVector_result_0 = room:GetGridEntity(gridIndexOrPosition)
+    end
+    local existingGridEntity = ____isVector_result_0
     if existingGridEntity ~= nil then
-        ____exports.removeGridEntity(nil, existingGridEntity)
+        ____exports.removeGrid(nil, existingGridEntity)
     end
-    local position = room:GetGridPosition(gridIndex)
+    local position = isVector(nil, gridIndexOrPosition) and gridIndexOrPosition or room:GetGridPosition(gridIndexOrPosition)
     local gridEntity = Isaac.GridSpawn(gridEntityType, variant, position)
     if gridEntity == nil then
         return gridEntity
@@ -201,7 +209,7 @@ function ____exports.isPostBossVoidPortal(self, gridEntity)
     local saveState = gridEntity:GetSaveState()
     return saveState.VarData == 1
 end
-function ____exports.removeAllGridEntitiesExceptFor(self, ...)
+function ____exports.removeAllGridExcept(self, ...)
     local gridEntityTypes = {...}
     local gridEntityTypeExceptions = __TS__New(Set, gridEntityTypes)
     local gridEntities = ____exports.getGridEntities(nil)
@@ -209,7 +217,7 @@ function ____exports.removeAllGridEntitiesExceptFor(self, ...)
     for ____, gridEntity in ipairs(gridEntities) do
         local gridEntityType = gridEntity:GetType()
         if not gridEntityTypeExceptions:has(gridEntityType) then
-            ____exports.removeGridEntity(nil, gridEntity, false)
+            ____exports.removeGrid(nil, gridEntity, false)
             removedOneOrMoreGridEntities = true
         end
     end
@@ -224,7 +232,7 @@ function ____exports.removeAllMatchingGridEntities(self, ...)
         return false
     end
     for ____, gridEntity in ipairs(gridEntities) do
-        ____exports.removeGridEntity(nil, gridEntity, false)
+        ____exports.removeGrid(nil, gridEntity, false)
     end
     roomUpdateSafe(nil)
     return true
@@ -239,16 +247,16 @@ function ____exports.spawnGiantPoop(self, topLeftGridIndex)
     local topRightGridIndex = topLeftGridIndex + 1
     local bottomLeftGridIndex = topLeftGridIndex + gridWidth
     local bottomRightGridIndex = bottomLeftGridIndex + 1
-    ____exports.spawnGridEntityWithVariant(nil, GridEntityType.GRID_POOP, 7, topLeftGridIndex)
-    ____exports.spawnGridEntityWithVariant(nil, GridEntityType.GRID_POOP, 8, topRightGridIndex)
-    ____exports.spawnGridEntityWithVariant(nil, GridEntityType.GRID_POOP, 9, bottomLeftGridIndex)
-    ____exports.spawnGridEntityWithVariant(nil, GridEntityType.GRID_POOP, 10, bottomRightGridIndex)
+    ____exports.spawnGridWithVariant(nil, GridEntityType.GRID_POOP, 7, topLeftGridIndex)
+    ____exports.spawnGridWithVariant(nil, GridEntityType.GRID_POOP, 8, topRightGridIndex)
+    ____exports.spawnGridWithVariant(nil, GridEntityType.GRID_POOP, 9, bottomLeftGridIndex)
+    ____exports.spawnGridWithVariant(nil, GridEntityType.GRID_POOP, 10, bottomRightGridIndex)
 end
-function ____exports.spawnGridEntity(self, gridEntityType, gridIndex)
-    return ____exports.spawnGridEntityWithVariant(nil, gridEntityType, 0, gridIndex)
+function ____exports.spawnGrid(self, gridEntityType, gridIndexOrPosition)
+    return ____exports.spawnGridWithVariant(nil, gridEntityType, 0, gridIndexOrPosition)
 end
 function ____exports.spawnVoidPortal(self, gridIndex)
-    local voidPortal = ____exports.spawnGridEntityWithVariant(nil, GridEntityType.GRID_TRAPDOOR, 1, gridIndex)
+    local voidPortal = ____exports.spawnGridWithVariant(nil, GridEntityType.GRID_TRAPDOOR, 1, gridIndex)
     if voidPortal == nil then
         return voidPortal
     end

package/dist/functions/jsonHelpers.d.ts

@@ -6,7 +6,7 @@
  * (This allows execution to continue in cases where users have no current save data or have
  * manually removed their existing save data.)
  */
-export declare function jsonDecode(jsonString: string): LuaTable;
+export declare function jsonDecode(jsonString: string): LuaTable<AnyNotNil, unknown>;
 /**
  * Converts a Lua table to a JSON string.
  * In most cases, this function will be used for writing data to a "save#.dat" file.

package/dist/functions/roomGrid.lua

@@ -26,7 +26,7 @@ function isValidGridPositionLRoom(self, gridPosition, roomShape)
         return false
     end
     local verticalTopLeft, verticalBottomRight, horizontalTopLeft, horizontalBottomRight = table.unpack(rectangles)
-    return inRectangle(nil, gridPosition, verticalTopLeft, verticalBottomRight) and inRectangle(nil, gridPosition, horizontalTopLeft, horizontalBottomRight)
+    return inRectangle(nil, gridPosition, verticalTopLeft, verticalBottomRight) or inRectangle(nil, gridPosition, horizontalTopLeft, horizontalBottomRight)
 end
 function ____exports.gridCoordinatesToWorldPosition(self, x, y)
     local gridPosition = Vector(x, y)

package/dist/types/Primitive.d.ts

@@ -0,0 +1 @@
+export declare type Primitive = boolean | number | string;

package/dist/types/Primitive.lua

@@ -0,0 +1,3 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+return ____exports

package/dist/types/private/SaveData.d.ts

@@ -1,4 +1,4 @@
-declare type Primitive = boolean | number | string;
+import { Primitive } from "../Primitive";
 declare type Serializable = Primitive | unknown;
 /**
  * Each sub-object of save data has a string as a key, without arbitrary data as a value. However,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.241",
+  "version": "1.2.244",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "isaac-typescript-definitions": "^1.0.388",
-    "isaacscript-lint": "^1.0.95",
+    "isaacscript-lint": "^1.0.98",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",
     "typescript": "4.6.3",