isaacscript-common 1.0.482 → 1.0.483

package/dist/features/deployJSONRoom.lua

@@ -201,6 +201,8 @@ function spawnAllEntities(self, jsonRoom, seed, verbose)
             log("Setting the room to be uncleared since there were one or more battle NPCs spawned.")
         end
         setRoomUncleared(nil)
+    elseif verbose then
+        log("Leaving the room cleared since there were no battle NPCs spawned.")
     end
     return seed
 end

package/dist/functions/entity.d.ts

@@ -60,6 +60,25 @@ export declare function getEffects(matchingVariant?: number, matchingSubType?: n
  * returned. False by default. Will only be taken into account if `matchingEntityType` is specified.
  */
 export declare function getEntities(matchingEntityType?: EntityType | int, matchingVariant?: number, matchingSubType?: number, ignoreFriendly?: boolean): Entity[];
+/**
+ * Helper function to get a map containing the positions of every entity in the current room.
+ *
+ * This is useful for rewinding entity positions at a later time. Also see `setEntityPositions()`.
+ *
+ * @param entities Optional. If provided, will only get the positions of the provided entities. This
+ * can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple times.
+ */
+export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Vector>;
+/**
+ * Helper function to get a map containing the velocities of every entity in the current room.
+ *
+ * This is useful for rewinding entity velocities at a later time. Also see `setEntityVelocities()`.
+ *
+ * @param entities Optional. If provided, will only get the velocities of the provided entities.
+ * This can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple
+ * times.
+ */
+export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector>;
 /**
  * Helper function to get all of the familiars in the room.
  *
@@ -144,4 +163,31 @@ export declare function removeAllMatchingEntities(entityType: int, entityVariant
 export declare function removeAllPickups(): void;
 export declare function removeAllProjectiles(): void;
 export declare function removeAllTears(): void;
+/**
+ * Helper function to set the position of every entity in the room based on a map of positions. If
+ * an entity is found that does not have matching element in the provided map, then that entity will
+ * be skipped.
+ *
+ * This function is useful for rewinding entity positions at a later time. Also see
+ * `getEntityPositions()`.
+ *
+ * @param entityPositions The map providing the positions for every entity.
+ * @param entities Optional. If provided, will only set the positions of the provided entities. This
+ * can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple times.
+ */
+export declare function setEntityPositions(entityPositions: Map<PtrHash, Vector>, entities?: Entity[]): void;
 export declare function setEntityRandomColor(entity: Entity): void;
+/**
+ * Helper function to set the velocity of every entity in the room based on a map of velocities. If
+ * an entity is found that does not have matching element in the provided map, then that entity will
+ * be skipped.
+ *
+ * This function is useful for rewinding entity velocities at a later time. Also see
+ * `getEntityVelocities()`.
+ *
+ * @param entityVelocities The map providing the velocities for every entity.
+ * @param entities Optional. If provided, will only set the velocities of the provided entities.
+ * This can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple
+ * times.
+ */
+export declare function setEntityVelocities(entityVelocities: Map<PtrHash, Vector>, entities?: Entity[]): void;

package/dist/functions/entity.lua

@@ -76,6 +76,28 @@ function ____exports.getEntities(self, matchingEntityType, matchingVariant, matc
     end
     return Isaac.FindByType(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
 end
+function ____exports.getEntityPositions(self, entities)
+    if entities == nil then
+        entities = ____exports.getEntities(nil)
+    end
+    local entityPositions = __TS__New(Map)
+    for ____, entity in ipairs(entities) do
+        local ptrHash = GetPtrHash(entity)
+        entityPositions:set(ptrHash, entity.Position)
+    end
+    return entityPositions
+end
+function ____exports.getEntityVelocities(self, entities)
+    if entities == nil then
+        entities = ____exports.getEntities(nil)
+    end
+    local entityVelocities = __TS__New(Map)
+    for ____, entity in ipairs(entities) do
+        local ptrHash = GetPtrHash(entity)
+        entityVelocities:set(ptrHash, entity.Velocity)
+    end
+    return entityVelocities
+end
 function ____exports.getFamiliars(self, matchingVariant, matchingSubType)
     if matchingVariant == nil then
         matchingVariant = -1
@@ -251,6 +273,18 @@ function ____exports.removeAllTears(self)
         tear:Remove()
     end
 end
+function ____exports.setEntityPositions(self, entityPositions, entities)
+    if entities == nil then
+        entities = ____exports.getEntities(nil)
+    end
+    for ____, entity in ipairs(entities) do
+        local ptrHash = GetPtrHash(entity)
+        local entityPosition = entityPositions:get(ptrHash)
+        if entityPosition ~= nil then
+            entity.Position = entityPosition
+        end
+    end
+end
 function ____exports.setEntityRandomColor(self, entity)
     local colorValues = {}
     local seed = entity.InitSeed
@@ -266,4 +300,16 @@ function ____exports.setEntityRandomColor(self, entity)
     local color = Color(colorValues[1], colorValues[2], colorValues[3])
     entity:SetColor(color, 100000, 100000, false, false)
 end
+function ____exports.setEntityVelocities(self, entityVelocities, entities)
+    if entities == nil then
+        entities = ____exports.getEntities(nil)
+    end
+    for ____, entity in ipairs(entities) do
+        local ptrHash = GetPtrHash(entity)
+        local entityVelocity = entityVelocities:get(ptrHash)
+        if entityVelocity ~= nil then
+            entity.Velocity = entityVelocity
+        end
+    end
+end
 return ____exports

package/dist/functions/gridEntity.d.ts

@@ -38,9 +38,30 @@ export declare function isAllPressurePlatesPushed(): boolean;
  * at the VarData of the entity.)
  */
 export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
+/**
+ * Helper function to remove most grid entities in the room.
+ *
+ * Example:
+ * ```
+ * removeAllGridEntitiesExceptFor(
+ *   GridEntityType.GRID_WALL,
+ *   GridEntityType.GRID_DOOR,
+ * );
+ * ```
+ */
 export declare function removeAllGridEntitiesExceptFor(...gridEntityTypes: GridEntityType[]): void;
 export declare function removeAllMatchingGridEntities(gridEntityType: GridEntityType): void;
-export declare function removeGridEntity(gridEntity: GridEntity): void;
+/**
+ * Helper function to remove a grid entity simply by providing the grid entity object.
+ *
+ * @param gridEntity The grid entity to remove.
+ * @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
+ * True by default. This is generally a good idea because if the room is not updated, you will be
+ * unable to spawn another grid entity on the same tile until a frame has passed. However, doing
+ * 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;
 /**
  * Helper function to make a grid entity invisible. This is accomplished by setting its sprite to
  * "gfx/none.png" (a non-existent PNG file).

package/dist/functions/gridEntity.lua

@@ -3,12 +3,19 @@ require("lualib_bundle");
 local ____exports = {}
 local ____constants = require("constants")
 local GRID_ENTITY_XML_MAP = ____constants.GRID_ENTITY_XML_MAP
-function ____exports.removeGridEntity(self, gridEntity)
+local ____rooms = require("functions.rooms")
+local roomUpdateSafe = ____rooms.roomUpdateSafe
+function ____exports.removeGridEntity(self, gridEntity, updateRoom)
+    if updateRoom == nil then
+        updateRoom = true
+    end
     local game = Game()
     local room = game:GetRoom()
     local gridIndex = gridEntity:GetGridIndex()
     room:RemoveGridEntity(gridIndex, 0, false)
-    room:Update()
+    if updateRoom then
+        roomUpdateSafe(nil)
+    end
 end
 function ____exports.spawnGridEntityWithVariant(self, gridEntityType, variant, gridIndex)
     local game = Game()
@@ -113,15 +120,17 @@ function ____exports.removeAllGridEntitiesExceptFor(self, ...)
     for ____, gridEntity in ipairs(gridEntities) do
         local gridEntityType = gridEntity:GetType()
         if not gridEntityTypeExceptions:has(gridEntityType) then
-            ____exports.removeGridEntity(nil, gridEntity)
+            ____exports.removeGridEntity(nil, gridEntity, false)
         end
     end
+    roomUpdateSafe(nil)
 end
 function ____exports.removeAllMatchingGridEntities(self, gridEntityType)
     local gridEntities = ____exports.getGridEntities(nil, gridEntityType)
     for ____, gridEntity in ipairs(gridEntities) do
-        ____exports.removeGridEntity(nil, gridEntity)
+        ____exports.removeGridEntity(nil, gridEntity, false)
     end
+    roomUpdateSafe(nil)
 end
 function ____exports.setGridEntityInvisible(self, gridEntity)
     local sprite = gridEntity:GetSprite()

package/dist/functions/rooms.d.ts

@@ -108,6 +108,13 @@ export declare function inDimension(dimension: Dimension): boolean;
 export declare function inLRoom(): boolean;
 export declare function inGenesisRoom(): boolean;
 export declare function inStartingRoom(): boolean;
+/**
+ * If `Room.Update()` is called in a PostNewRoom callback, then some entities will slide around
+ * (such as the player). Since those entity velocities are already at zero, setting them to zero
+ * will have no effect. Thus, a generic solution is to record all of the entity positions/velocities
+ * before updating the room, and then restore those positions/velocities.
+ */
+export declare function roomUpdateSafe(): void;
 /**
  * Helper function to convert an uncleared room to a cleared room in the PostNewRoom callback. This
  * is useful because if enemies are removed in this callback, a room drop will be awarded and the

package/dist/functions/rooms.lua

@@ -11,6 +11,12 @@ local ____doors = require("functions.doors")
 local closeAllDoors = ____doors.closeAllDoors
 local getDoors = ____doors.getDoors
 local isHiddenSecretRoomDoor = ____doors.isHiddenSecretRoomDoor
+local ____entity = require("functions.entity")
+local getEntities = ____entity.getEntities
+local getEntityPositions = ____entity.getEntityPositions
+local getEntityVelocities = ____entity.getEntityVelocities
+local setEntityPositions = ____entity.setEntityPositions
+local setEntityVelocities = ____entity.setEntityVelocities
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
 function ____exports.getRoomIndex(self)
@@ -196,6 +202,16 @@ function ____exports.inStartingRoom(self)
     local roomIndex = ____exports.getRoomIndex(nil)
     return roomIndex == startingRoomIndex
 end
+function ____exports.roomUpdateSafe(self)
+    local game = Game()
+    local room = game:GetRoom()
+    local entities = getEntities(nil)
+    local entityPositions = getEntityPositions(nil, entities)
+    local entityVelocities = getEntityVelocities(nil, entities)
+    room:Update()
+    setEntityPositions(nil, entityPositions, entities)
+    setEntityVelocities(nil, entityVelocities, entities)
+end
 function ____exports.setRoomCleared(self)
     local game = Game()
     local room = game:GetRoom()
@@ -210,14 +226,14 @@ function ____exports.setRoomCleared(self)
     ) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue38
+                goto __continue39
             end
             door.State = DoorState.STATE_OPEN
             local sprite = door:GetSprite()
             sprite:Play("Opened", true)
             door.ExtraVisible = false
         end
-        ::__continue38::
+        ::__continue39::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.482",
+  "version": "1.0.483",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",