isaacscript-common 1.2.239 → 1.2.242

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)
@@ -129,7 +129,7 @@ function fillRoomWithDecorations(self)
                 goto __continue30
             end
             local position = room:GetGridPosition(gridIndex)
-            local decoration = Isaac.GridSpawn(GridEntityType.GRID_DECORATION, 0, position, true)
+            local decoration = Isaac.GridSpawn(GridEntityType.GRID_DECORATION, 0, position)
             if decoration ~= nil then
                 setGridEntityInvisible(nil, decoration)
             end
@@ -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/entitySpecific.d.ts

@@ -217,6 +217,10 @@ export declare function spawnKnifeWithSeed(variant: KnifeVariant | int, subType:
 export declare function spawnLaser(variant: LaserVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityLaser;
 /** Helper function to spawn a `EntityType.ENTITY_LASER` (7) with a specific seed. */
 export declare function spawnLaserWithSeed(variant: LaserVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
+/** Helper function to spawn an NPC. */
+export declare function spawnNPC(entityType: EntityType | int, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityNPC;
+/** Helper function to spawn an NPC with a specific seed. */
+export declare function spawnNPCWithSeed(entityType: EntityType | int, variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityNPC;
 /** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5). */
 export declare function spawnPickup(variant: PickupVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with a specific seed. */

package/dist/functions/entitySpecific.lua

@@ -428,6 +428,50 @@ function ____exports.spawnLaserWithSeed(self, variant, subType, position, seed,
         seed
     )
 end
+function ____exports.spawnNPC(self, entityType, variant, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    local entity = spawn(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local npc = entity:ToNPC()
+    if npc == nil then
+        error("Failed to spawn an NPC.")
+    end
+    return npc
+end
+function ____exports.spawnNPCWithSeed(self, entityType, variant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnNPC(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
 function ____exports.spawnPickup(self, variant, subType, position, velocity, spawner, seed)
     if velocity == nil then
         velocity = VectorZero

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,14 +56,20 @@ 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 gridEntity = Isaac.GridSpawn(gridEntityType, variant, position, true)
+    local position = isVector(nil, gridIndexOrPosition) and gridIndexOrPosition or room:GetGridPosition(gridIndexOrPosition)
+    local gridEntity = Isaac.GridSpawn(gridEntityType, variant, position)
     if gridEntity == nil then
         return gridEntity
     end
@@ -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/pickups.d.ts

@@ -15,6 +15,8 @@ export declare function getKeys(matchingSubType?: number): EntityPickup[];
 export declare function getPills(matchingSubType?: number): EntityPickup[];
 /** Helper function to get all of the red heart pickup entities in the room. */
 export declare function getRedHearts(): EntityPickup[];
+/** Helper function to get all of the sack (i.e. grab bag) entities in the room. */
+export declare function getSacks(matchingSubType?: number): EntityPickup[];
 /** Helper function to get all of the trinket entities in the room. */
 export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
 export declare function isChest(pickup: EntityPickup): boolean;
@@ -76,6 +78,14 @@ export declare function removeAllKeys(keySubType?: KeySubType | int, cap?: int):
  * @returns True if one or more pills were removed, false otherwise.
  */
 export declare function removeAllPills(pillColor?: PillColor, cap?: int): boolean;
+/**
+ * Helper function to remove all of the sacks (i.e. grab bags) in the room.
+ *
+ * @param sackSubType Optional. If specified, will only remove sacks that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of trinkets.
+ * @returns True if one or more trinkets were removed, false otherwise.
+ */
+export declare function removeAllSacks(sackSubType?: SackSubType | int, cap?: int): boolean;
 /**
  * Helper function to remove all of the trinkets in the room.
  *
@@ -121,6 +131,12 @@ export declare function spawnKeyWithSeed(subType: KeySubType | int, position: Ve
  */
 export declare function spawnPill(subType: PillColor | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
 export declare function spawnPillWithSeed(subType: PillColor | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+/**
+ * Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with variant
+ * `PickupVariant.PICKUP_GRAB_BAG` (69).
+ */
+export declare function spawnSack(subType: SackSubType | int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnSackWithSeed(subType: SackSubType | int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /**
  * Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with variant
  * `PickupVariant.PICKUP_TRINKET` (350).

package/dist/functions/pickups.lua

@@ -60,6 +60,12 @@ function ____exports.getRedHearts(self)
         function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
     )
 end
+function ____exports.getSacks(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, 69, matchingSubType)
+end
 function ____exports.getTrinkets(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
@@ -93,6 +99,9 @@ end
 function ____exports.removeAllPills(self, pillColor, cap)
     return removeAllPickups(nil, 70, pillColor, cap)
 end
+function ____exports.removeAllSacks(self, sackSubType, cap)
+    return removeAllPickups(nil, 350, sackSubType, cap)
+end
 function ____exports.removeAllTrinkets(self, trinketType, cap)
     return removeAllPickups(nil, 350, trinketType, cap)
 end
@@ -312,6 +321,42 @@ function ____exports.spawnPillWithSeed(self, subType, position, seed, velocity,
         seed
     )
 end
+function ____exports.spawnSack(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        69,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnSackWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnSack(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
 function ____exports.spawnTrinket(self, subType, position, velocity, spawner, seed)
     if velocity == nil then
         velocity = VectorZero

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.239",
+  "version": "1.2.242",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.387",
+    "isaac-typescript-definitions": "^1.0.388",
     "isaacscript-lint": "^1.0.95",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",