isaacscript-common 3.2.0 → 3.3.0

package/callbacks/customRevive.lua

@@ -1,5 +1,5 @@
 local ____exports = {}
-local hasSubscriptions, postRender, postNewRoom, postPEffectUpdateReordered, checkWaitingForItemAnimation, postPlayerFatalDamage, preBerserkDeath, playerIsAboutToDie, logStateChanged, DEBUG, CustomReviveState, v
+local hasSubscriptions, postRender, postNewRoomReordered, postPEffectUpdateReordered, checkWaitingForItemAnimation, postPlayerFatalDamage, preBerserkDeath, playerIsAboutToDie, logStateChanged, DEBUG, CustomReviveState, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local FamiliarVariant = ____isaac_2Dtypescript_2Ddefinitions.FamiliarVariant
@@ -41,7 +41,7 @@ function postRender(self)
     end
     sfxManager:Stop(SoundEffect.ONE_UP)
 end
-function postNewRoom(self)
+function postNewRoomReordered(self)
     if v.run.state ~= CustomReviveState.WAITING_FOR_ROOM_TRANSITION then
         return
     end
@@ -139,7 +139,7 @@ v = {run = {state = CustomReviveState.DISABLED, revivalType = nil, dyingPlayerIn
 function ____exports.customReviveCallbacksInit(self, mod)
     saveDataManager(nil, "customRevive", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
-    mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
     mod:AddCallbackCustom(ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, postPEffectUpdateReordered)
     mod:AddCallbackCustom(ModCallbackCustom.POST_PLAYER_FATAL_DAMAGE, postPlayerFatalDamage)
     mod:AddCallbackCustom(ModCallbackCustom.PRE_BERSERK_DEATH, preBerserkDeath)

package/callbacks/postGridEntity.lua

@@ -3,9 +3,11 @@ local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local hasSubscriptions, postUpdate, checkGridEntitiesRemoved, checkGridEntityStateChanged, checkNewGridEntity, updateTupleInMap, postNewRoom, v
+local hasSubscriptions, postUpdate, checkGridEntitiesRemoved, checkGridEntityStateChanged, checkNewGridEntity, updateTupleInMap, postNewRoomReordered, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____gridEntity = require("functions.gridEntity")
@@ -85,7 +87,7 @@ function updateTupleInMap(self, gridEntity)
     local newTuple = {gridEntityType, gridEntityVariant, gridEntity.State}
     v.room.initializedGridEntities:set(gridIndex, newTuple)
 end
-function postNewRoom(self)
+function postNewRoomReordered(self)
     if not hasSubscriptions(nil) then
         return
     end
@@ -102,6 +104,6 @@ v = {room = {initializedGridEntities = __TS__New(Map)}}
 function ____exports.postGridEntityCallbacksInit(self, mod)
     saveDataManager(nil, "postGridEntity", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
-    mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
 end
 return ____exports

package/callbacks/postRoomClearChanged.lua

@@ -1,9 +1,11 @@
 local ____exports = {}
-local hasSubscriptions, postUpdate, postNewRoom, v
+local hasSubscriptions, postUpdate, postNewRoomReordered, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____postRoomClearChanged = require("callbacks.subscriptions.postRoomClearChanged")
@@ -23,7 +25,7 @@ function postUpdate(self)
         postRoomClearChangedFire(nil, roomClear)
     end
 end
-function postNewRoom(self)
+function postNewRoomReordered(self)
     if not hasSubscriptions(nil) then
         return
     end
@@ -37,6 +39,6 @@ v = {room = {cleared = false}}
 function ____exports.postRoomClearChangedCallbackInit(self, mod)
     saveDataManager(nil, "postRoomClearChanged", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
-    mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
 end
 return ____exports

package/callbacks/postSlotInitUpdate.lua

@@ -2,9 +2,11 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local hasSubscriptions, postUpdate, postNewRoom, checkNewEntity, v
+local hasSubscriptions, postUpdate, postNewRoomReordered, checkNewEntity, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____entitySpecific = require("functions.entitySpecific")
@@ -27,7 +29,7 @@ function postUpdate(self)
         postSlotUpdateFire(nil, slot)
     end
 end
-function postNewRoom(self)
+function postNewRoomReordered(self)
     if not hasSubscriptions(nil) then
         return
     end
@@ -48,6 +50,6 @@ v = {room = {initializedSlots = __TS__New(Set)}}
 function ____exports.postSlotInitUpdateCallbacksInit(self, mod)
     saveDataManager(nil, "postSlotInitUpdate", v, hasSubscriptions)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
-    mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
 end
 return ____exports

package/features/deployJSONRoom.lua

@@ -4,7 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local postNewRoom, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
+local postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
 local EntityCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityCollisionClass
@@ -12,7 +12,6 @@ local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
-local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
 local PitfallVariant = ____isaac_2Dtypescript_2Ddefinitions.PitfallVariant
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
@@ -20,6 +19,8 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____DefaultMap = require("classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
 local ____entity = require("functions.entity")
@@ -57,7 +58,7 @@ local ____utils = require("functions.utils")
 local erange = ____utils.erange
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
-function postNewRoom(self)
+function postNewRoomReordered(self)
     local roomListIndex = getRoomListIndex(nil)
     if not v.level.deployedRoomListIndexes:has(roomListIndex) then
         return
@@ -427,7 +428,7 @@ v = {level = {
 -- @internal
 function ____exports.deployJSONRoomInit(self, mod)
     saveDataManager(nil, "deployJSONRoom", v)
-    mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
 end
 --- Helper function to deconstruct a vanilla room and set up a custom room in its place.
 -- Specifically, this will clear the current room of all entities and grid entities, and then spawn

package/features/extraConsoleCommands/listCommands.lua

@@ -810,6 +810,7 @@ end
 --- Logs information about the room to the "log.txt" file.
 function ____exports.roomCommand(self)
     logRoom()
+    printConsole(nil, "Logged room information to the \"log.txt\" file.")
 end
 --- Gives a rotten heart. Provide a number to give a custom amount of hearts. (You can use negative
 -- numbers to remove hearts.)

package/features/persistentEntities.d.ts

@@ -0,0 +1,28 @@
+import { EntityType } from "isaac-typescript-definitions";
+/**
+ * Helper function to spawn an entity that will have persistence similar to a pickup.
+ *
+ * By default, as soon as you leave a room, any spawned entities will be despawned and will not
+ * return if the player revisits the room. This means that if you want to have an entity like a
+ * pickup, you have to manually respawn it when the player re-enters the room. Use this helper
+ * function to avoid having to do any tracking on your own.
+ *
+ * Conventionally, the word "persistent" refers to `EntityFlag.FLAG_PERSISTENT`, which is used on
+ * e.g. familiars to make them appear in every room. On the other hand, pickups are also persistent,
+ * but they are not present in every room, only one specific room. This function spawns entities
+ * like pickups, not familiars.
+ *
+ * @returns A tuple containing the entity and the persistent entity index. You can use the index
+ *          with the `removePersistentEntity` function.
+ */
+export declare function spawnPersistentEntity(entityType: EntityType, variant: int, subType: int, position: Vector): [Entity, int];
+/**
+ * Helper function to stop an entity spawned with the `spawnPersistentEntity` helper function from
+ * respawning.
+ *
+ * @param persistentEntityIndex The index that was returned by the `spawnPersistentEntity` function.
+ * @param removeEntity Optional. True by default. Set to false if you want to stop an entity from
+ *                     being persistent but you don't want to actually remove the currently-spawned
+ *                     entity from the room.
+ */
+export declare function removePersistentEntity(persistentEntityIndex: int, removeEntity?: boolean): void;

package/features/persistentEntities.lua

@@ -0,0 +1,150 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local postEntityRemove, postNewRoomReordered, spawnAndTrack, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____entity = require("functions.entity")
+local spawn = ____entity.spawn
+local ____roomData = require("functions.roomData")
+local getRoomListIndex = ____roomData.getRoomListIndex
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postEntityRemove(self, entity)
+    local ptrHash = GetPtrHash(entity)
+    local tuple = v.room.spawnedPersistentEntities:get(ptrHash)
+    if tuple == nil then
+        return
+    end
+    local index = tuple[1]
+    local level = game:GetLevel()
+    local previousRoomGridIndex = level:GetPreviousRoomIndex()
+    local previousRoomListIndex = getRoomListIndex(nil, previousRoomGridIndex)
+    v.level.persistentEntities:set(index, {
+        entityType = entity.Type,
+        variant = entity.Variant,
+        subType = entity.SubType,
+        roomListIndex = previousRoomListIndex,
+        position = entity.Position
+    })
+end
+function postNewRoomReordered(self)
+    local roomListIndex = getRoomListIndex(nil)
+    for ____, ____value in __TS__Iterator(v.level.persistentEntities:entries()) do
+        local index = ____value[1]
+        local description = ____value[2]
+        do
+            if roomListIndex ~= description.roomListIndex then
+                goto __continue6
+            end
+            v.level.persistentEntities:delete(index)
+            spawnAndTrack(
+                nil,
+                description.entityType,
+                description.variant,
+                description.subType,
+                description.position,
+                index,
+                true
+            )
+        end
+        ::__continue6::
+    end
+end
+function spawnAndTrack(self, entityType, variant, subType, position, index, respawning)
+    if respawning == nil then
+        respawning = false
+    end
+    local entity = spawn(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position
+    )
+    if respawning then
+        entity:ClearEntityFlags(EntityFlag.APPEAR)
+    end
+    local ptrHash = GetPtrHash(entity)
+    local tuple = {
+        index,
+        EntityPtr(entity)
+    }
+    v.room.spawnedPersistentEntities:set(ptrHash, tuple)
+    return entity
+end
+--- Iterates upward as new persistent entities are created.
+local persistentEntityIndexCounter = 0
+v = {
+    level = {persistentEntities = __TS__New(Map)},
+    room = {spawnedPersistentEntities = __TS__New(Map)}
+}
+---
+-- @internal
+function ____exports.persistentEntitiesInit(self, mod)
+    saveDataManager(nil, "persistentEntities", v)
+    mod:AddCallback(ModCallback.POST_ENTITY_REMOVE, postEntityRemove)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
+end
+--- Helper function to spawn an entity that will have persistence similar to a pickup.
+-- 
+-- By default, as soon as you leave a room, any spawned entities will be despawned and will not
+-- return if the player revisits the room. This means that if you want to have an entity like a
+-- pickup, you have to manually respawn it when the player re-enters the room. Use this helper
+-- function to avoid having to do any tracking on your own.
+-- 
+-- Conventionally, the word "persistent" refers to `EntityFlag.FLAG_PERSISTENT`, which is used on
+-- e.g. familiars to make them appear in every room. On the other hand, pickups are also persistent,
+-- but they are not present in every room, only one specific room. This function spawns entities
+-- like pickups, not familiars.
+-- 
+-- @returns A tuple containing the entity and the persistent entity index. You can use the index
+-- with the `removePersistentEntity` function.
+function ____exports.spawnPersistentEntity(self, entityType, variant, subType, position)
+    persistentEntityIndexCounter = persistentEntityIndexCounter + 1
+    local entity = spawnAndTrack(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        persistentEntityIndexCounter
+    )
+    return {entity, persistentEntityIndexCounter}
+end
+--- Helper function to stop an entity spawned with the `spawnPersistentEntity` helper function from
+-- respawning.
+-- 
+-- @param persistentEntityIndex The index that was returned by the `spawnPersistentEntity` function.
+-- @param removeEntity Optional. True by default. Set to false if you want to stop an entity from
+-- being persistent but you don't want to actually remove the currently-spawned
+-- entity from the room.
+function ____exports.removePersistentEntity(self, persistentEntityIndex, removeEntity)
+    if removeEntity == nil then
+        removeEntity = true
+    end
+    v.level.persistentEntities:delete(persistentEntityIndex)
+    for ____, ____value in __TS__Iterator(v.room.spawnedPersistentEntities:entries()) do
+        local ptrHash = ____value[1]
+        local tuple = ____value[2]
+        do
+            local index, entityPtr = table.unpack(tuple)
+            if index ~= persistentEntityIndex then
+                goto __continue13
+            end
+            v.room.spawnedPersistentEntities:delete(ptrHash)
+            if removeEntity and entityPtr.Ref ~= nil then
+                entityPtr.Ref:Remove()
+            end
+        end
+        ::__continue13::
+    end
+end
+return ____exports

package/functions/color.d.ts

@@ -9,9 +9,6 @@ interface CopyColorReturn {
     [SerializationType.SERIALIZE]: SerializedColor;
     [SerializationType.DESERIALIZE]: Color;
 }
-/**
- * @category color
- */
 export declare function colorEquals(color1: Color, color2: Color): boolean;
 /**
  * Helper function to copy a `Color` object.
@@ -19,27 +16,16 @@ export declare function colorEquals(color1: Color, color2: Color): boolean;
  * @param color The Color object to copy. In the case of deserialization, this will actually be a
  *              Lua table instead of an instantiated Color class.
  * @param serializationType Default is `SerializationType.NONE`.
- * @category color
  */
 export declare function copyColor<C extends Color | SerializedColor, S extends SerializationType>(color: C, serializationType: S): CopyColorReturn[S];
 export declare function copyColor<C extends Color | SerializedColor>(color: C): CopyColorReturn[SerializationType.NONE];
-/**
- * Returns `Color(1, 1, 1)`.
- *
- * @category color
- */
+/** Returns `Color(1, 1, 1)`. */
 export declare function getDefaultColor(): Color;
-/**
- * Helper function to check if something is an instantiated Color object.
- *
- * @category color
- */
+/** Helper function to check if something is an instantiated Color object. */
 export declare function isColor(object: unknown): object is Color;
 /**
  * Used to determine is the given table is a serialized `Color` object created by the save data
  * manager and/or the `deepCopy` function.
- *
- * @category color
  */
 export declare function isSerializedColor(object: unknown): object is SerializedColor;
 export {};

package/functions/color.lua

@@ -14,8 +14,6 @@ local tableHasKeys = ____table.tableHasKeys
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 --- Helper function to check if something is an instantiated Color object.
--- 
--- @category color
 function ____exports.isColor(self, object)
     return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
 end
@@ -29,8 +27,6 @@ local KEYS = {
     "BO"
 }
 OBJECT_NAME = "Color"
----
--- @category color
 function ____exports.colorEquals(self, color1, color2)
     return isaacAPIClassEquals(nil, color1, color2, KEYS)
 end
@@ -39,7 +35,6 @@ end
 -- @param color The Color object to copy. In the case of deserialization, this will actually be a
 -- Lua table instead of an instantiated Color class.
 -- @param serializationType Default is `SerializationType.NONE`.
--- @category color
 function ____exports.copyColor(self, color, serializationType)
     if serializationType == nil then
         serializationType = SerializationType.NONE
@@ -116,15 +111,11 @@ function ____exports.copyColor(self, color, serializationType)
     until true
 end
 --- Returns `Color(1, 1, 1)`.
--- 
--- @category color
 function ____exports.getDefaultColor(self)
     return Color(1, 1, 1)
 end
 --- Used to determine is the given table is a serialized `Color` object created by the save data
 -- manager and/or the `deepCopy` function.
--- 
--- @category color
 function ____exports.isSerializedColor(self, object)
     local objectType = type(object)
     if objectType ~= "table" then

package/functions/entity.d.ts

@@ -11,6 +11,16 @@ import { AnyEntity } from "../types/AnyEntity";
  * @param ignoreFriendly Default is false.
  */
 export declare function countEntities(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): int;
+/**
+ * Helper function to check if one or more of a specific kind of entity is present in the current
+ * room. It uses the `countEntities` helper function to determine this.
+ *
+ * @param entityType Default is -1. -1 matches every entity type.
+ * @param variant Default is -1. -1 matches every variant.
+ * @param subType Default is -1. -1 matches every sub-type.
+ * @param ignoreFriendly Default is false.
+ */
+export declare function doesEntityExist(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): boolean;
 /**
  * Given an array of entities, this helper function returns the closest one to a provided reference
  * entity.

package/functions/entity.lua

@@ -66,6 +66,35 @@ function ____exports.countEntities(self, entityType, variant, subType, ignoreFri
     )
     return #entities
 end
+--- Helper function to check if one or more of a specific kind of entity is present in the current
+-- room. It uses the `countEntities` helper function to determine this.
+-- 
+-- @param entityType Default is -1. -1 matches every entity type.
+-- @param variant Default is -1. -1 matches every variant.
+-- @param subType Default is -1. -1 matches every sub-type.
+-- @param ignoreFriendly Default is false.
+function ____exports.doesEntityExist(self, entityType, variant, subType, ignoreFriendly)
+    if entityType == nil then
+        entityType = -1
+    end
+    if variant == nil then
+        variant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    if ignoreFriendly == nil then
+        ignoreFriendly = false
+    end
+    local count = ____exports.countEntities(
+        nil,
+        entityType,
+        variant,
+        subType,
+        ignoreFriendly
+    )
+    return count > 0
+end
 --- Given an array of entities, this helper function returns the closest one to a provided reference
 -- entity.
 -- 

package/functions/log.lua

@@ -229,7 +229,7 @@ function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
     if numMatchedEntities == 0 then
         msg = msg .. "(no entities matched)\n"
     else
-        msg = msg .. ("(" .. tostring(numMatchedEntities)) .. " total entities)\n"
+        msg = msg .. ((("(" .. tostring(numMatchedEntities)) .. " total ") .. (numMatchedEntities == 1 and "entity" or "entities")) .. ")\n"
     end
     ____exports.log(msg)
 end
@@ -336,7 +336,7 @@ function ____exports.logGridEntities(includeWalls, gridEntityTypeFilter)
     if numMatchedEntities == 0 then
         msg = msg .. "(no grid entities matched)\n"
     else
-        msg = msg .. ("(" .. tostring(numMatchedEntities)) .. " total grid entities)\n"
+        msg = msg .. ((("(" .. tostring(numMatchedEntities)) .. " total grid ") .. (numMatchedEntities == 1 and "entity" or "entities")) .. ")\n"
     end
     ____exports.log(msg)
 end

package/index.d.ts

@@ -20,6 +20,7 @@ export { removeFadeIn, restoreFadeIn } from "./features/fadeInRemover";
 export { disableFastReset, enableFastReset } from "./features/fastReset";
 export { forgottenSwitch } from "./features/forgottenSwitch";
 export { getCollectibleItemPoolType } from "./features/getCollectibleItemPoolType";
+export { removePersistentEntity, spawnPersistentEntity, } from "./features/persistentEntities";
 export { addCollectible, getPlayerInventory } from "./features/playerInventory";
 export * from "./features/ponyDetection";
 export { preventCollectibleRotation } from "./features/preventCollectibleRotation";

package/index.lua

@@ -167,6 +167,13 @@ do
     local getCollectibleItemPoolType = ____getCollectibleItemPoolType.getCollectibleItemPoolType
     ____exports.getCollectibleItemPoolType = getCollectibleItemPoolType
 end
+do
+    local ____persistentEntities = require("features.persistentEntities")
+    local removePersistentEntity = ____persistentEntities.removePersistentEntity
+    local spawnPersistentEntity = ____persistentEntities.spawnPersistentEntity
+    ____exports.removePersistentEntity = removePersistentEntity
+    ____exports.spawnPersistentEntity = spawnPersistentEntity
+end
 do
     local ____playerInventory = require("features.playerInventory")
     local addCollectible = ____playerInventory.addCollectible

package/initFeatures.lua

@@ -17,6 +17,8 @@ local ____forgottenSwitch = require("features.forgottenSwitch")
 local forgottenSwitchInit = ____forgottenSwitch.forgottenSwitchInit
 local ____getCollectibleItemPoolType = require("features.getCollectibleItemPoolType")
 local getCollectibleItemPoolTypeInit = ____getCollectibleItemPoolType.getCollectibleItemPoolTypeInit
+local ____persistentEntities = require("features.persistentEntities")
+local persistentEntitiesInit = ____persistentEntities.persistentEntitiesInit
 local ____playerInventory = require("features.playerInventory")
 local playerInventoryInit = ____playerInventory.playerInventoryInit
 local ____ponyDetection = require("features.ponyDetection")
@@ -42,6 +44,7 @@ function ____exports.initFeaturesMinor(self, mod)
     fastResetInit(nil, mod)
     forgottenSwitchInit(nil, mod)
     getCollectibleItemPoolTypeInit(nil, mod)
+    persistentEntitiesInit(nil, mod)
     playerInventoryInit(nil, mod)
     ponyDetectionInit(nil, mod)
     preventCollectibleRotationInit(nil, mod)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",