isaacscript-common 1.2.172 → 1.2.175

package/dist/functions/collectibles.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
 import { CollectiblePedestalType } from "../enums/CollectiblePedestalType";
-export declare function collectibleHasTag(collectibleType: CollectibleType | int, tag: ItemConfigTag): boolean;
+import { CollectibleIndex } from "../types/CollectibleIndex";
 export declare function clearCollectibleSprite(collectible: EntityPickup): void;
 export declare function collectibleHasCacheFlag(collectibleType: CollectibleType | int, cacheFlag: CacheFlag): boolean;
+export declare function collectibleHasTag(collectibleType: CollectibleType | int, tag: ItemConfigTag): boolean;
 /**
  * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
  * provided collectible type was not valid.
@@ -18,16 +19,42 @@ export declare function getCollectibleDevilHeartPrice(collectibleType: Collectib
  * "gfx/items/collectibles/questionmark.png" if the provided collectible type was not valid.
  */
 export declare function getCollectibleGfxFilename(collectibleType: CollectibleType | int): string;
+/**
+ * Mods often have to track variables relating to a collectible. Finding an index for these kinds of
+ * data structures is difficult, since collectibles are respawned every time a player re-enters a
+ * room, so the `PtrHash` will change. Instead, we use a 3-tuple of the room list index, the grid
+ * index of the collectible in the room, and the collectible's InitSeed.
+ *
+ * When collectibles are rolled (e.g. with a D6), their InitSeed changes. If you want to track
+ * collectibles independently of any rerolls, then use the `PtrHash` as an index instead. (The
+ * `PtrHash` will not persist between rooms, however.)
+ *
+ * Note that:
+ * - The grid index is a necessary part of the collectible index because Diplopia and Crooked Penny
+ * can cause two or more collectibles with the same sub-type and InitSeed to exist in the same room.
+ * - This index will fail in the case where the player uses Diplopia or a successful Crooked Penny
+ * seven or more times in the same room, since that will cause two or more collectibles with the
+ * same grid index and InitSeed to exist.
+ * - Using a collectible's position as part of the index is problematic, since players can push a
+ * pedestal. (Even using the grid index does not solve this problem, since it is possible in certain
+ * cases for collectibles to be spawned at a position that is not aligned with the grid, and the
+ * pedestal pushed to an adjacent tile, but this case should be extremely rare.)
+ * - Mega Chests spawn two collectibles on the exact same position. However, both of them will have
+ * different InitSeeds, so this is not a problem for this indexing scheme.
+ * - The indexing scheme used is different for collectibles that are inside of a Treasure Room, in
+ * order to handle the case of the player seeing the same collectible again in a post-Ascent
+ * Treasure Room. An 4-tuple of stage, stage type, grid index, and InitSeed is used in this case.
+ * (Using the room list index or the room grid index is not suitable for this purpose, since both
+ * of these values can change in the post-Ascent Treasure Room.) Even though there can be two
+ * Treasure Rooms on an XL floor, both Treasure Rooms should not have collectibles with the same
+ * InitSeed.
+ */
+export declare function getCollectibleIndex(collectible: EntityPickup): CollectibleIndex;
 /**
  * Helper function to get the initial amount of charges that a collectible has. Returns 0 if the
  * provided collectible type was not valid.
  */
-export declare function getCollectibleInitCharges(collectibleType: CollectibleType | int): int;
-/**
- * Helper function to get the path to a collectible's quality. Returns 0 if the provided collectible
- * type was not valid.
- */
-export declare function getCollectibleQuality(collectibleType: CollectibleType | int): int;
+export declare function getCollectibleInitCharge(collectibleType: CollectibleType | int): int;
 /**
  * Helper function to get the `ItemType` of a collectible. Returns `ItemType.ITEM_NULL` if the
  * provided collectible type was not valid.
@@ -50,6 +77,11 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  */
 export declare function getCollectibleName(collectibleType: CollectibleType | int): string;
 export declare function getCollectiblePedestalType(collectible: EntityPickup): CollectiblePedestalType;
+/**
+ * Helper function to get the path to a collectible's quality. Returns 0 if the provided collectible
+ * type was not valid.
+ */
+export declare function getCollectibleQuality(collectibleType: CollectibleType | int): int;
 /** Helper function to get all of the collectible entities in the room. */
 export declare function getCollectibles(matchingSubType?: number): EntityPickup[];
 /**
@@ -59,6 +91,8 @@ export declare function getCollectibles(matchingSubType?: number): EntityPickup[
  * collectibles.
  */
 export declare function getMaxCollectibleType(): int;
+/** Returns true if the item type in the item config is equal to `ItemType.ITEM_ACTIVE`. */
+export declare function isActiveCollectible(collectibleType: CollectibleType | int): boolean;
 /**
  * Returns whether or not the given collectible is a "glitched" item. All items are replaced by
  * glitched items once a player has TMTRAINER. However, glitched items can also "naturally" appear
@@ -86,11 +120,6 @@ export declare function isSingleUseCollectible(collectibleType: CollectibleType
  * @returns True if one or more collectibles was removed, false otherwise.
  */
 export declare function removeAllCollectibles(collectibleType?: CollectibleType | int, cap?: int): boolean;
-/**
- * Helper function to remove all pickup delay on a collectible. By default, collectibles have a 20
- * frame delay before they can be picked up by a player.
- */
-export declare function removeCollectiblePickupDelay(collectible: EntityPickup): void;
 /**
  * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that it
  * should remove an item.
@@ -100,10 +129,14 @@ export declare function removeCollectiblePickupDelay(collectible: EntityPickup):
  */
 export declare function removeCollectibleFromItemTracker(collectibleType: CollectibleType | int): void;
 /**
- * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that
- * the build has been rerolled.
+ * Helper function to remove all pickup delay on a collectible. By default, collectibles have a 20
+ * frame delay before they can be picked up by a player.
+ */
+export declare function removeCollectiblePickupDelay(collectible: EntityPickup): void;
+/**
+ * Helper function to set a collectible sprite to a question mark (i.e. how collectibles look when
+ * the player has Curse of the Blind).
  */
-export declare function setCollectiblesRerolledForItemTracker(): void;
 export declare function setCollectibleBlind(collectible: EntityPickup): void;
 /**
  * Helper function to remove the collectible from a collectible pedestal and make it appear as if a
@@ -130,3 +163,8 @@ export declare function setCollectibleSprite(collectible: EntityPickup, pngPath:
  * not sufficient because the sprite will not change.
  */
 export declare function setCollectibleSubType(collectible: EntityPickup, newCollectibleType: CollectibleType | int): void;
+/**
+ * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that
+ * the build has been rerolled.
+ */
+export declare function setCollectiblesRerolledForItemTracker(): void;

package/dist/functions/collectibles.lua

@@ -2,6 +2,7 @@
 local ____exports = {}
 local COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER
 local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
 local itemConfig = ____cachedClasses.itemConfig
 local ____constants = require("constants")
 local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
@@ -17,6 +18,8 @@ local hasFlag = ____flag.hasFlag
 local ____pickups = require("functions.pickups")
 local getPickups = ____pickups.getPickups
 local removeAllPickups = ____pickups.removeAllPickups
+local ____roomData = require("functions.roomData")
+local getRoomListIndex = ____roomData.getRoomListIndex
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
 function ____exports.setCollectibleSprite(self, collectible, pngPath)
@@ -34,13 +37,6 @@ end
 COLLECTIBLE_SPRITE_LAYER = 1
 COLLECTIBLE_SHADOW_LAYER = 4
 local GLITCHED_ITEM_THRESHOLD = 4000000000
-function ____exports.collectibleHasTag(self, collectibleType, tag)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return false
-    end
-    return itemConfigItem:HasTags(tag)
-end
 function ____exports.clearCollectibleSprite(self, collectible)
     ____exports.setCollectibleSprite(nil, collectible, nil)
 end
@@ -51,6 +47,13 @@ function ____exports.collectibleHasCacheFlag(self, collectibleType, cacheFlag)
     end
     return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
 end
+function ____exports.collectibleHasTag(self, collectibleType, tag)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return false
+    end
+    return itemConfigItem:HasTags(tag)
+end
 function ____exports.getCollectibleDescription(self, collectibleType)
     local collectibleDescription = COLLECTIBLE_DESCRIPTION_MAP:get(collectibleType)
     if collectibleDescription ~= nil then
@@ -85,19 +88,28 @@ function ____exports.getCollectibleGfxFilename(self, collectibleType)
     end
     return itemConfigItem.GfxFileName
 end
-function ____exports.getCollectibleInitCharges(self, collectibleType)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return 0
+function ____exports.getCollectibleIndex(self, collectible)
+    if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
+        error("You cannot get a collectible index for pickups of variant: " .. tostring(collectible.Variant))
     end
-    return itemConfigItem.InitCharge
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local gridIndex = room:GetGridIndex(collectible.Position)
+    local roomListIndex = getRoomListIndex(nil)
+    if roomType == RoomType.ROOM_TREASURE then
+        return (((((tostring(stage) .. ",") .. tostring(stageType)) .. ",") .. tostring(gridIndex)) .. ",") .. tostring(collectible.InitSeed)
+    end
+    return (((tostring(roomListIndex) .. ",") .. tostring(gridIndex)) .. ",") .. tostring(collectible.InitSeed)
 end
-function ____exports.getCollectibleQuality(self, collectibleType)
+function ____exports.getCollectibleInitCharge(self, collectibleType)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
         return 0
     end
-    return itemConfigItem.Quality
+    return itemConfigItem.InitCharge
 end
 function ____exports.getCollectibleItemType(self, collectibleType)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
@@ -131,6 +143,13 @@ function ____exports.getCollectiblePedestalType(self, collectible)
     local sprite = collectible:GetSprite()
     return sprite:GetOverlayFrame()
 end
+function ____exports.getCollectibleQuality(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return 0
+    end
+    return itemConfigItem.Quality
+end
 function ____exports.getCollectibles(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
@@ -140,6 +159,10 @@ end
 function ____exports.getMaxCollectibleType(self)
     return itemConfig:GetCollectibles().Size - 1
 end
+function ____exports.isActiveCollectible(self, collectibleType)
+    local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
+    return itemType == ItemType.ITEM_ACTIVE
+end
 function ____exports.isGlitchedCollectible(self, pickup)
     return pickup.Variant == PickupVariant.PICKUP_COLLECTIBLE and pickup.SubType > GLITCHED_ITEM_THRESHOLD
 end
@@ -156,19 +179,16 @@ end
 function ____exports.removeAllCollectibles(self, collectibleType, cap)
     return removeAllPickups(nil, PickupVariant.PICKUP_COLLECTIBLE, collectibleType, cap)
 end
+function ____exports.removeCollectibleFromItemTracker(self, collectibleType)
+    local collectibleName = ____exports.getCollectibleName(nil, collectibleType)
+    Isaac.DebugString(((("Removing collectible " .. tostring(collectibleType)) .. " (") .. collectibleName) .. ") on player 0 (Player)")
+end
 function ____exports.removeCollectiblePickupDelay(self, collectible)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
         error("You cannot remove pickup delay for pickups of variant: " .. tostring(collectible.Variant))
     end
     collectible.Wait = 0
 end
-function ____exports.removeCollectibleFromItemTracker(self, collectibleType)
-    local collectibleName = ____exports.getCollectibleName(nil, collectibleType)
-    Isaac.DebugString(((("Removing collectible " .. tostring(collectibleType)) .. " (") .. collectibleName) .. ") on player 0 (Player)")
-end
-function ____exports.setCollectiblesRerolledForItemTracker(self)
-    Isaac.DebugString("Added 3 Collectibles")
-end
 function ____exports.setCollectibleBlind(self, collectible)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
         error("You cannot set a collectible to be blind for pickups of variant: " .. tostring(collectible.Variant))
@@ -199,4 +219,7 @@ function ____exports.setCollectibleSubType(self, collectible, newCollectibleType
         true
     )
 end
+function ____exports.setCollectiblesRerolledForItemTracker(self)
+    Isaac.DebugString("Added 3 Collectibles")
+end
 return ____exports

package/dist/functions/color.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
-export declare function getDefaultColor(): Color;
-export declare function getDefaultKColor(): KColor;
 export declare function copyColor(color: Color): Color;
 export declare function copyKColor(kColor: KColor): KColor;
+export declare function getDefaultColor(): Color;
+export declare function getDefaultKColor(): KColor;

package/dist/functions/color.lua

@@ -1,11 +1,5 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-function ____exports.getDefaultColor(self)
-    return Color(1, 1, 1)
-end
-function ____exports.getDefaultKColor(self)
-    return KColor(1, 1, 1, 1)
-end
 function ____exports.copyColor(self, color)
     return Color(
         color.R,
@@ -20,4 +14,10 @@ end
 function ____exports.copyKColor(self, kColor)
     return KColor(kColor.Red, kColor.Green, kColor.Blue, kColor.Alpha)
 end
+function ____exports.getDefaultColor(self)
+    return Color(1, 1, 1)
+end
+function ____exports.getDefaultKColor(self)
+    return KColor(1, 1, 1, 1)
+end
 return ____exports

package/dist/functions/deepCopy.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
-/// <reference types="isaac-typescript-definitions" />
 import { SerializationType } from "../enums/SerializationType";
 /**
  * deepCopy is a semi-generic deep cloner. It will recursively copy all of the values so that none
@@ -21,8 +20,6 @@ import { SerializationType } from "../enums/SerializationType";
  * @param traversalDescription Used to track the current key that we are operating on.
  */
 export declare function deepCopy(oldObject: LuaTable | Map<AnyNotNil, unknown> | Set<AnyNotNil>, serializationType?: SerializationType, traversalDescription?: string): LuaTable | Map<AnyNotNil, unknown> | Set<AnyNotNil>;
-export declare function deserializeVector(vectorTable: LuaTable): Vector;
-export declare function addTraversalDescription(key: AnyNotNil, traversalDescription: string): string;
 /**
  * Used to determine is the given table is a serialized Vector created by the save data manager
  * and/or the `deepCopy` function.

package/dist/functions/deepCopy.lua

@@ -18,7 +18,10 @@ local ____constants = require("features.saveDataManager.constants")
 local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local ____log = require("functions.log")
 local log = ____log.log
+local ____utils = require("functions.utils")
+local getTraversalDescription = ____utils.getTraversalDescription
 local ____vector = require("functions.vector")
+local deserializeVector = ____vector.deserializeVector
 local isVector = ____vector.isVector
 function ____exports.deepCopy(self, oldObject, serializationType, traversalDescription)
     if serializationType == nil then
@@ -205,10 +208,10 @@ function deepCopyValue(self, oldObject, newObject, key, value, traversalDescript
         newValue = copyVector(nil, vector, serializationType)
     elseif ____exports.isSerializedVector(nil, value) and serializationType == SerializationType.DESERIALIZE then
         local serializedVector = value
-        newValue = ____exports.deserializeVector(nil, serializedVector)
+        newValue = deserializeVector(nil, serializedVector)
     elseif valueType == "table" then
         local ____table = value
-        traversalDescription = ____exports.addTraversalDescription(nil, key, traversalDescription)
+        traversalDescription = getTraversalDescription(nil, key, traversalDescription)
         newValue = ____exports.deepCopy(nil, ____table, serializationType, traversalDescription)
     else
         newValue = value
@@ -233,19 +236,6 @@ function copyVector(self, vector, serializationType)
     local newVector = Vector(vector.X, vector.Y)
     return newVector
 end
-function ____exports.deserializeVector(self, vectorTable)
-    local xString = vectorTable.X
-    local x = tonumber(xString)
-    if x == nil then
-        error("Failed to read the X value of a serialized vector.")
-    end
-    local yString = vectorTable.Y
-    local y = tonumber(yString)
-    if y == nil then
-        error("Failed to read the Y value of a serialized vector.")
-    end
-    return Vector(x, y)
-end
 function checkMetatable(self, ____table, traversalDescription)
     local metatable = getmetatable(____table)
     if metatable == nil then
@@ -262,13 +252,6 @@ function validateValue(self, value, valueType, traversalDescription)
         error(((("The deepCopy function detected that \"" .. traversalDescription) .. "\" is type ") .. valueType) .. ", which is not supported.")
     end
 end
-function ____exports.addTraversalDescription(self, key, traversalDescription)
-    if traversalDescription ~= "" then
-        traversalDescription = traversalDescription .. " --> "
-    end
-    traversalDescription = traversalDescription .. tostring(key)
-    return traversalDescription
-end
 function ____exports.isSerializedVector(self, object)
     local objectType = type(object)
     if objectType ~= "table" then

package/dist/functions/doors.d.ts

@@ -6,6 +6,13 @@ export declare function closeAllDoors(): void;
  */
 export declare function closeDoorFast(door: GridEntityDoor): void;
 export declare function doorSlotToDirection(doorSlot: DoorSlot): Direction;
+export declare function getAngelRoomDoor(): GridEntityDoor | undefined;
+export declare function getDevilRoomDoor(): GridEntityDoor | undefined;
+/**
+ * If there is both a Devil Room and an Angel Room door, this function will return door with the
+ * lowest slot number.
+ */
+export declare function getDevilRoomOrAngelRoomDoor(): GridEntityDoor | undefined;
 /**
  * Helper function to get all of the doors in the room. By default, it will return every door. You
  * can optionally specify one or more room types to return only the doors that match the specified
@@ -19,17 +26,9 @@ export declare function getDoors(...roomTypes: RoomType[]): GridEntityDoor[];
  * that match any of the N room grid indexes.
  */
 export declare function getDoorsToRoomIndex(...roomGridIndex: int[]): GridEntityDoor[];
-export declare function getAngelRoomDoor(): GridEntityDoor | undefined;
-export declare function getDevilRoomDoor(): GridEntityDoor | undefined;
-/**
- * If there is both a Devil Room and an Angel Room door, this function will return door with the
- * lowest slot number.
- */
-export declare function getDevilRoomOrAngelRoomDoor(): GridEntityDoor | undefined;
 export declare function getRepentanceDoor(): GridEntityDoor | undefined;
 export declare function isAngelRoomDoor(door: GridEntityDoor): boolean;
 export declare function isDevilRoomDoor(door: GridEntityDoor): boolean;
-export declare function isHiddenSecretRoomDoor(door: GridEntityDoor): boolean;
 /**
  * This refers to the Repentance door that spawns in a boss room after defeating the boss.
  * You have to spend one key to open it.
@@ -60,6 +59,7 @@ export declare function isDoorToMines(door: GridEntityDoor): boolean;
  * It has a sprite filename of "gfx/grid/Door_MomsHeart.anm2".
  */
 export declare function isDoorToMomsHeart(door: GridEntityDoor): boolean;
+export declare function isHiddenSecretRoomDoor(door: GridEntityDoor): boolean;
 export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
 export declare function isSecretRoomDoor(door: GridEntityDoor): boolean;
 /**

package/dist/functions/doors.lua

@@ -23,13 +23,13 @@ function ____exports.getDoors(self, ...)
             do
                 local door = room:GetDoor(i)
                 if door == nil then
-                    goto __continue8
+                    goto __continue11
                 end
                 if #roomTypes == 0 or roomTypesSet:has(door.TargetRoomType) then
                     __TS__ArrayPush(doors, door)
                 end
             end
-            ::__continue8::
+            ::__continue11::
             i = i + 1
         end
     end
@@ -66,15 +66,6 @@ end
 function ____exports.doorSlotToDirection(self, doorSlot)
     return DOOR_SLOT_TO_DIRECTION[doorSlot]
 end
-function ____exports.getDoorsToRoomIndex(self, ...)
-    local roomGridIndex = {...}
-    local roomGridIndexesSet = __TS__New(Set, roomGridIndex)
-    local doors = ____exports.getDoors(nil)
-    return __TS__ArrayFilter(
-        doors,
-        function(____, door) return roomGridIndexesSet:has(door.TargetRoomIndex) end
-    )
-end
 function ____exports.getAngelRoomDoor(self)
     local angelRoomDoors = ____exports.getDoors(nil, RoomType.ROOM_ANGEL)
     local ____temp_0
@@ -105,6 +96,15 @@ function ____exports.getDevilRoomOrAngelRoomDoor(self)
     end
     return ____temp_2
 end
+function ____exports.getDoorsToRoomIndex(self, ...)
+    local roomGridIndex = {...}
+    local roomGridIndexesSet = __TS__New(Set, roomGridIndex)
+    local doors = ____exports.getDoors(nil)
+    return __TS__ArrayFilter(
+        doors,
+        function(____, door) return roomGridIndexesSet:has(door.TargetRoomIndex) end
+    )
+end
 function ____exports.getRepentanceDoor(self)
     local doors = ____exports.getDoors(nil)
     return __TS__ArrayFind(
@@ -118,11 +118,6 @@ end
 function ____exports.isDevilRoomDoor(self, door)
     return door.TargetRoomType == RoomType.ROOM_DEVIL
 end
-function ____exports.isHiddenSecretRoomDoor(self, door)
-    local sprite = door:GetSprite()
-    local animation = sprite:GetAnimation()
-    return ____exports.isSecretRoomDoor(nil, door) and animation == "Hidden"
-end
 function ____exports.isDoorToDownpour(self, door)
     if not ____exports.isRepentanceDoor(nil, door) then
         return false
@@ -163,6 +158,11 @@ function ____exports.isDoorToMomsHeart(self, door)
     local filename = sprite:GetFilename()
     return filename == "gfx/grid/Door_MomsHeart.anm2"
 end
+function ____exports.isHiddenSecretRoomDoor(self, door)
+    local sprite = door:GetSprite()
+    local animation = sprite:GetAnimation()
+    return ____exports.isSecretRoomDoor(nil, door) and animation == "Hidden"
+end
 function ____exports.lockDoor(self, door)
     local level = game:GetLevel()
     local roomDescriptor = level:GetRoomByIdx(door.TargetRoomIndex)

package/dist/functions/entity.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
 import { AnyEntity } from "../types/AnyEntity";
-export declare function anyEntityCloserThan(entities: Entity[], position: Vector, distance: int): boolean;
 /**
  * Helper function to count the number of entities in room. Use this over the vanilla
  * `Isaac.CountEntities` method to avoid having to specify a spawner and to handle ignoring charmed
@@ -24,11 +23,6 @@ export declare function countEntities(entityType?: EntityType | int, variant?: n
  * ```
  */
 export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity: Entity, entities: T[]): T;
-/**
- * Helper function to compare two different arrays of entities. Returns the entities that are in the
- * second array but not in the first array.
- */
-export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities: T[], newEntities: T[]): T[];
 /**
  * Helper function to get all of the entities in the room or all of the entities that match a
  * specific entity type / variant / sub-type.
@@ -55,6 +49,11 @@ export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities:
 export declare function getEntities(matchingEntityType?: EntityType | int, matchingVariant?: number, matchingSubType?: number, ignoreFriendly?: boolean): Entity[];
 /** Helper function to return a string containing an entity's type, variant, and sub-type. */
 export declare function getEntityID(entity: Entity): string;
+/**
+ * Helper function to compare two different arrays of entities. Returns the entities that are in the
+ * second array but not in the first array.
+ */
+export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities: T[], newEntities: T[]): T[];
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *
@@ -68,14 +67,6 @@ export declare function isEntityMoving(entity: Entity, threshold?: number): bool
  * to non-story bosses, like Vanishing Twin. Also see the `STORY_BOSSES` constant.
  */
 export declare function isStoryBoss(entity: Entity): boolean;
-/**
- * Helper function to remove all of the entities in the supplied array.
- *
- * @param entities The array of entities to remove.
- * @param cap Optional. If specified, will only remove the given amount of entities.
- * @returns True if one or more entities was removed, false otherwise.
- */
-export declare function removeEntities(entities: Entity[], cap?: int): boolean;
 /**
  * Helper function to remove all of the matching entities in the room.
  *
@@ -88,6 +79,14 @@ export declare function removeEntities(entities: Entity[], cap?: int): boolean;
  * @returns True if one or more entities was removed, false otherwise.
  */
 export declare function removeAllMatchingEntities(entityType: int, entityVariant?: number, entitySubType?: number, cap?: int | undefined): boolean;
+/**
+ * Helper function to remove all of the entities in the supplied array.
+ *
+ * @param entities The array of entities to remove.
+ * @param cap Optional. If specified, will only remove the given amount of entities.
+ * @returns True if one or more entities was removed, false otherwise.
+ */
+export declare function removeEntities(entities: Entity[], cap?: int): boolean;
 /**
  * Helper function to reroll an enemy. Use this instead of the vanilla "Game.RerollEnemy" function
  * if you want the rerolled enemy to be returned.

package/dist/functions/entity.lua

@@ -1,6 +1,5 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
-local __TS__ArraySome = ____lualib.__TS__ArraySome
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
@@ -15,11 +14,19 @@ local getRandom = ____random.getRandom
 local nextSeed = ____random.nextSeed
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
-function ____exports.anyEntityCloserThan(self, entities, position, distance)
-    return __TS__ArraySome(
-        entities,
-        function(____, entity) return position:Distance(entity.Position) <= distance end
-    )
+function ____exports.removeEntities(self, entities, cap)
+    if #entities == 0 then
+        return false
+    end
+    local numEntitiesRemoved = 0
+    for ____, entity in ipairs(entities) do
+        entity:Remove()
+        numEntitiesRemoved = numEntitiesRemoved + 1
+        if cap ~= nil and numEntitiesRemoved >= cap then
+            return true
+        end
+    end
+    return true
 end
 function ____exports.countEntities(self, entityType, variant, subType, ignoreFriendly)
     if entityType == nil then
@@ -61,20 +68,6 @@ function ____exports.getClosestEntityTo(self, referenceEntity, entities)
     end
     return closestEntity
 end
-function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
-    local oldEntitiesSet = __TS__New(Set)
-    for ____, entity in ipairs(oldEntities) do
-        local ptrHash = GetPtrHash(entity)
-        oldEntitiesSet:add(ptrHash)
-    end
-    return __TS__ArrayFilter(
-        newEntities,
-        function(____, entity)
-            local ptrHash = GetPtrHash(entity)
-            return not oldEntitiesSet:has(ptrHash)
-        end
-    )
-end
 function ____exports.getEntities(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
     if matchingVariant == nil then
         matchingVariant = -1
@@ -93,6 +86,20 @@ end
 function ____exports.getEntityID(self, entity)
     return (((tostring(entity.Type) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType)
 end
+function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
+    local oldEntitiesSet = __TS__New(Set)
+    for ____, entity in ipairs(oldEntities) do
+        local ptrHash = GetPtrHash(entity)
+        oldEntitiesSet:add(ptrHash)
+    end
+    return __TS__ArrayFilter(
+        newEntities,
+        function(____, entity)
+            local ptrHash = GetPtrHash(entity)
+            return not oldEntitiesSet:has(ptrHash)
+        end
+    )
+end
 function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
         threshold = 0.01
@@ -102,20 +109,6 @@ end
 function ____exports.isStoryBoss(self, entity)
     return STORY_BOSSES:has(entity.Type)
 end
-function ____exports.removeEntities(self, entities, cap)
-    if #entities == 0 then
-        return false
-    end
-    local numEntitiesRemoved = 0
-    for ____, entity in ipairs(entities) do
-        entity:Remove()
-        numEntitiesRemoved = numEntitiesRemoved + 1
-        if cap ~= nil and numEntitiesRemoved >= cap then
-            return true
-        end
-    end
-    return true
-end
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
     if entityVariant == nil then
         entityVariant = -1

package/dist/functions/gridEntity.d.ts

@@ -5,6 +5,13 @@
  * 1000.0 in a room XML file, but `GridEntityType.GRID_ROCK` is equal to 2.
  */
 export declare function convertXMLGridEntityType(gridEntityXMLType: int, gridEntityXMLVariant: int): [int, int] | undefined;
+/**
+ * Gets the entities that have a hitbox that overlaps with any part of the square that the grid
+ * entity is on.
+ *
+ * Note that this function will not work properly in the PostNewRoom callback, since entities do not
+ * have collision yet in that callback.
+ */
 export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntity): Entity[];
 /**
  * Helper function to get every grid entity in the current room.
@@ -37,13 +44,13 @@ export declare function getGridEntities(...gridEntityTypes: GridEntityType[]): G
  * arguments to match specific grid entity types.
  */
 export declare function getGridEntitiesMap(...gridEntityTypes: GridEntityType[]): Map<int, GridEntity>;
+export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 export declare function getTopLeftWall(): GridEntity | undefined;
 /**
  * Helper function to get the grid index of the top left wall.
  * (This will depend on what the current room shape is.)
  */
 export declare function getTopLeftWallGridIndex(): int;
-export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 /**
  * Helper function to determine if all of the pressure plates in the current room are pushed.
  * Returns true if there are no pressure plates in the room.