isaacscript-common 3.0.0 → 3.2.0

package/features/saveDataManager/save.lua

@@ -11,28 +11,33 @@ local ____jsonHelpers = require("functions.jsonHelpers")
 local jsonEncode = ____jsonHelpers.jsonEncode
 local ____log = require("functions.log")
 local log = ____log.log
+local ____table = require("functions.table")
+local iterateTableDeterministically = ____table.iterateTableDeterministically
 local ____constants = require("features.saveDataManager.constants")
+local SAVE_DATA_MANAGER_DEBUG = ____constants.SAVE_DATA_MANAGER_DEBUG
 local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_NAME
 function getAllSaveDataToWriteToDisk(self, saveDataMap, saveDataConditionalFuncMap)
     local allSaveData = {}
-    for subscriberName, saveData in pairs(saveDataMap) do
-        do
+    iterateTableDeterministically(
+        nil,
+        saveDataMap,
+        function(____, subscriberName, saveData)
             local conditionalFunc = saveDataConditionalFuncMap:get(subscriberName)
             if conditionalFunc ~= nil then
                 local shouldSave = conditionalFunc(nil)
                 if not shouldSave then
-                    goto __continue4
+                    return
                 end
             end
             local saveDataWithoutRoom = {persistent = saveData.persistent, run = saveData.run, level = saveData.level}
             if #__TS__ObjectKeys(saveDataWithoutRoom) == 0 then
-                goto __continue4
+                return
             end
             local saveDataCopy = deepCopy(nil, saveDataWithoutRoom, SerializationType.SERIALIZE, subscriberName)
             allSaveData[subscriberName] = saveDataCopy
-        end
-        ::__continue4::
-    end
+        end,
+        SAVE_DATA_MANAGER_DEBUG
+    )
     return allSaveData
 end
 function ____exports.saveToDisk(self, mod, saveDataMap, saveDataConditionalFuncMap)

package/functions/array.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
  * only performs a shallow comparison.

package/functions/bombs.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="isaac-typescript-definitions" />
+/** Helper function to find out how large a bomb explosion is based on the damage inflicted. */
+export declare function getBombRadiusFromDamage(damage: float): float;

package/functions/bombs.lua

@@ -0,0 +1,12 @@
+local ____exports = {}
+--- Helper function to find out how large a bomb explosion is based on the damage inflicted.
+function ____exports.getBombRadiusFromDamage(self, damage)
+    if damage > 175 then
+        return 105
+    end
+    if damage <= 140 then
+        return 75
+    end
+    return 90
+end
+return ____exports

package/functions/chargeBar.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 import { ChargeBarSprites } from "../interfaces/ChargeBarSprites";
 /**
  * Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`

package/functions/collectibles.d.ts

@@ -8,9 +8,14 @@ export declare function collectibleSpriteEquals(sprite1: Sprite, sprite2: Sprite
  * provided collectible type was not valid.
  */
 export declare function getCollectibleDescription(collectibleType: CollectibleType): string;
+/**
+ * Helper function to get the coin cost that a collectible item would be if it were being offered in
+ * a Devil Room deal. Returns 0 if passed `CollectibleType.NULL`.
+ */
+export declare function getCollectibleDevilCoinPrice(collectibleType: CollectibleType): int;
 /**
  * Helper function to get the heart cost that a collectible item would be if it were being offered
- * in a Devil Room deal. Returns 0 if passed CollectibleType.NULL.
+ * in a Devil Room deal. Returns 0 if passed `CollectibleType.NULL`.
  */
 export declare function getCollectibleDevilHeartPrice(collectibleType: CollectibleType, player: EntityPlayer): PickupPrice;
 /**
@@ -47,13 +52,13 @@ export declare function getCollectibleGfxFilename(collectibleType: CollectibleTy
  *   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. A 5-tuple of stage, stage type, grid index, SubType, 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 grid index, Subtype, and InitSeed.
+ * - The indexing scheme used is different for collectibles that are inside of a Treasure Room or
+ *   Boss Room, in order to handle the case of the player seeing the same collectible again in a
+ *   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, SubType,
+ *   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 rooms.)
+ *   Even though Treasure Rooms and Boss Rooms are grouped together in this scheme, there probably
+ *   will not be collectibles with the same grid index, SubType, and InitSeed.
  */
 export declare function getCollectibleIndex(collectible: EntityPickup): CollectibleIndex;
 /**

package/functions/collectibles.lua

@@ -108,8 +108,21 @@ function ____exports.getCollectibleDescription(self, collectibleType)
     end
     return DEFAULT_COLLECTIBLE_DESCRIPTION
 end
+--- Helper function to get the coin cost that a collectible item would be if it were being offered in
+-- a Devil Room deal. Returns 0 if passed `CollectibleType.NULL`.
+function ____exports.getCollectibleDevilCoinPrice(self, collectibleType)
+    if collectibleType == CollectibleType.NULL then
+        return 0
+    end
+    local defaultCollectiblePrice = 15
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return defaultCollectiblePrice
+    end
+    return itemConfigItem.DevilPrice * defaultCollectiblePrice
+end
 --- Helper function to get the heart cost that a collectible item would be if it were being offered
--- in a Devil Room deal. Returns 0 if passed CollectibleType.NULL.
+-- in a Devil Room deal. Returns 0 if passed `CollectibleType.NULL`.
 function ____exports.getCollectibleDevilHeartPrice(self, collectibleType, player)
     local maxHearts = player:GetMaxHearts()
     if collectibleType == CollectibleType.NULL then
@@ -118,10 +131,10 @@ function ____exports.getCollectibleDevilHeartPrice(self, collectibleType, player
     if maxHearts == 0 then
         return PickupPrice.THREE_SOUL_HEARTS
     end
-    local defaultPickupPrice = PickupPrice.ONE_HEART
+    local defaultCollectiblePrice = PickupPrice.ONE_HEART
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then
-        return defaultPickupPrice
+        return defaultCollectiblePrice
     end
     local twoHeartPrice = maxHearts == 2 and PickupPrice.ONE_HEART_AND_TWO_SOUL_HEARTS or PickupPrice.TWO_HEARTS
     return itemConfigItem.DevilPrice == 2 and twoHeartPrice or PickupPrice.ONE_HEART
@@ -163,13 +176,13 @@ end
 --   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. A 5-tuple of stage, stage type, grid index, SubType, 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 grid index, Subtype, and InitSeed.
+-- - The indexing scheme used is different for collectibles that are inside of a Treasure Room or
+--   Boss Room, in order to handle the case of the player seeing the same collectible again in a
+--   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, SubType,
+--   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 rooms.)
+--   Even though Treasure Rooms and Boss Rooms are grouped together in this scheme, there probably
+--   will not be collectibles with the same grid index, SubType, and InitSeed.
 function ____exports.getCollectibleIndex(self, collectible)
     if not isCollectible(nil, collectible) then
         local entityID = getEntityID(nil, collectible)
@@ -182,7 +195,7 @@ function ____exports.getCollectibleIndex(self, collectible)
     local roomType = room:GetType()
     local gridIndex = room:GetGridIndex(collectible.Position)
     local roomListIndex = getRoomListIndex(nil)
-    if roomType == RoomType.TREASURE then
+    if roomType == RoomType.TREASURE or roomType == RoomType.BOSS then
         return (((((((tostring(stage) .. ",") .. tostring(stageType)) .. ",") .. tostring(gridIndex)) .. ",") .. tostring(collectible.SubType)) .. ",") .. tostring(collectible.InitSeed)
     end
     return (((((tostring(roomListIndex) .. ",") .. tostring(gridIndex)) .. ",") .. tostring(collectible.SubType)) .. ",") .. tostring(collectible.InitSeed)

package/functions/deepCopy.lua

@@ -1,11 +1,9 @@
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
-local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 local Map = ____lualib.Map
-local WeakMap = ____lualib.WeakMap
-local WeakSet = ____lualib.WeakSet
 local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
 local deepCopyTable, deepCopyDefaultMap, deepCopyMap, deepCopySet, deepCopyTSTLClass, deepCopyArray, deepCopyNormalLuaTable, getCopiedEntries, checkMetatable, deepCopyUserdata, COPYABLE_ISAAC_API_CLASS_TYPES_SET
@@ -26,19 +24,25 @@ local isArray = ____array.isArray
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____isaacAPIClass = require("functions.isaacAPIClass")
-local getIsaacAPIClassType = ____isaacAPIClass.getIsaacAPIClassType
+local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____log = require("functions.log")
 local log = ____log.log
+local logTable = ____log.logTable
 local ____serialization = require("functions.serialization")
 local copyIsaacAPIClass = ____serialization.copyIsaacAPIClass
 local deserializeIsaacAPIClass = ____serialization.deserializeIsaacAPIClass
 local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local ____tstlClass = require("functions.tstlClass")
+local getTSTLClassName = ____tstlClass.getTSTLClassName
+local isDefaultMap = ____tstlClass.isDefaultMap
+local isTSTLMap = ____tstlClass.isTSTLMap
+local isTSTLSet = ____tstlClass.isTSTLSet
 local isUserDefinedTSTLClass = ____tstlClass.isUserDefinedTSTLClass
 local newTSTLClass = ____tstlClass.newTSTLClass
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 local getTraversalDescription = ____utils.getTraversalDescription
+local twoDimensionalSort = ____utils.twoDimensionalSort
 --- `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
 -- of the nested references remain.
 -- 
@@ -120,19 +124,20 @@ function ____exports.deepCopy(self, value, serializationType, traversalDescripti
     until true
 end
 function deepCopyTable(self, ____table, serializationType, traversalDescription)
-    if __TS__InstanceOf(____table, DefaultMap) or ____table[SerializationBrand.DEFAULT_MAP] ~= nil then
+    if isDefaultMap(nil, ____table) or ____table[SerializationBrand.DEFAULT_MAP] ~= nil then
         return deepCopyDefaultMap(nil, ____table, serializationType, traversalDescription)
     end
-    if __TS__InstanceOf(____table, Map) or ____table[SerializationBrand.MAP] ~= nil then
+    if isTSTLMap(nil, ____table) or ____table[SerializationBrand.MAP] ~= nil then
         return deepCopyMap(nil, ____table, serializationType, traversalDescription)
     end
-    if __TS__InstanceOf(____table, Set) or ____table[SerializationBrand.SET] ~= nil then
+    if isTSTLSet(nil, ____table) or ____table[SerializationBrand.SET] ~= nil then
         return deepCopySet(nil, ____table, serializationType, traversalDescription)
     end
-    if __TS__InstanceOf(____table, WeakMap) then
+    local className = getTSTLClassName(nil, ____table)
+    if className == "WeakMap" then
         error("The deep copy function does not support copying the \"WeakMap\" class for: " .. traversalDescription)
     end
-    if __TS__InstanceOf(____table, WeakSet) then
+    if className == "WeakSet" then
         error("The deep copy function does not support copying the \"WeakSet\" class for: " .. traversalDescription)
     end
     if isUserDefinedTSTLClass(nil, ____table) then
@@ -148,13 +153,13 @@ function deepCopyTable(self, ____table, serializationType, traversalDescription)
     return deepCopyNormalLuaTable(nil, ____table, serializationType, traversalDescription)
 end
 function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescription)
-    local ____temp_0
-    if __TS__InstanceOf(defaultMap, DefaultMap) then
-        ____temp_0 = defaultMap:getConstructorArg()
+    local ____isDefaultMap_result_0
+    if isDefaultMap(nil, defaultMap) then
+        ____isDefaultMap_result_0 = defaultMap:getConstructorArg()
     else
-        ____temp_0 = nil
+        ____isDefaultMap_result_0 = nil
     end
-    local constructorArg = ____temp_0
+    local constructorArg = ____isDefaultMap_result_0
     local newDefaultMap
     repeat
         local ____switch23 = serializationType
@@ -180,7 +185,7 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
         ____cond23 = ____cond23 or ____switch23 == SerializationType.DESERIALIZE
         if ____cond23 then
             do
-                if __TS__InstanceOf(defaultMap, DefaultMap) then
+                if isDefaultMap(nil, defaultMap) then
                     error(("The deep copy function failed to deserialize a default map of \"" .. traversalDescription) .. "\", since it was not a Lua table.")
                 end
                 local defaultMapValue = defaultMap[SerializationBrand.DEFAULT_MAP_VALUE]
@@ -201,7 +206,7 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
     local entries = ____getCopiedEntries_result_1.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_1.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
-        if __TS__InstanceOf(newDefaultMap, DefaultMap) then
+        if isDefaultMap(nil, newDefaultMap) then
             newDefaultMap:set(SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "")
         else
             newDefaultMap[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
@@ -210,7 +215,7 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
     for ____, ____value in ipairs(entries) do
         local key = ____value[1]
         local value = ____value[2]
-        if __TS__InstanceOf(newDefaultMap, DefaultMap) then
+        if isDefaultMap(nil, newDefaultMap) then
             newDefaultMap:set(key, value)
         else
             newDefaultMap[key] = value
@@ -230,7 +235,7 @@ function deepCopyMap(self, map, serializationType, traversalDescription)
     local entries = ____getCopiedEntries_result_2.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_2.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
-        if __TS__InstanceOf(newMap, Map) then
+        if isTSTLMap(nil, newMap) then
             newMap:set(SerializationBrand.OBJECT_WITH_NUMBER_KEYS, "")
         else
             newMap[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
@@ -239,7 +244,7 @@ function deepCopyMap(self, map, serializationType, traversalDescription)
     for ____, ____value in ipairs(entries) do
         local key = ____value[1]
         local value = ____value[2]
-        if __TS__InstanceOf(newMap, Map) then
+        if isTSTLMap(nil, newMap) then
             newMap:set(key, value)
         else
             newMap[key] = value
@@ -259,7 +264,7 @@ function deepCopySet(self, set, serializationType, traversalDescription)
     local entries = ____getCopiedEntries_result_3.entries
     local convertedNumberKeysToStrings = ____getCopiedEntries_result_3.convertedNumberKeysToStrings
     if convertedNumberKeysToStrings then
-        if __TS__InstanceOf(newSet, Set) then
+        if isTSTLSet(nil, newSet) then
             error("The deep copy function cannot convert number keys to strings for a Set.")
         else
             newSet[SerializationBrand.OBJECT_WITH_NUMBER_KEYS] = ""
@@ -267,7 +272,7 @@ function deepCopySet(self, set, serializationType, traversalDescription)
     end
     for ____, ____value in ipairs(entries) do
         local key = ____value[1]
-        if __TS__InstanceOf(newSet, Set) then
+        if isTSTLSet(nil, newSet) then
             newSet:add(key)
         else
             newSet[key] = ""
@@ -320,7 +325,7 @@ function deepCopyNormalLuaTable(self, ____table, serializationType, traversalDes
 end
 function getCopiedEntries(self, object, serializationType, traversalDescription)
     local entries = {}
-    if __TS__InstanceOf(object, Map) or __TS__InstanceOf(object, Set) then
+    if isTSTLMap(nil, object) or isTSTLSet(nil, object) or isDefaultMap(nil, object) then
         for ____, ____value in __TS__Iterator(object:entries()) do
             local key = ____value[1]
             local value = ____value[2]
@@ -331,6 +336,10 @@ function getCopiedEntries(self, object, serializationType, traversalDescription)
             entries[#entries + 1] = {key, value}
         end
     end
+    if SAVE_DATA_MANAGER_DEBUG then
+        logTable(entries)
+        __TS__ArraySort(entries, twoDimensionalSort)
+    end
     local hasNumberKeys = __TS__ArraySome(
         entries,
         function(____, ____bindingPattern0)
@@ -346,14 +355,14 @@ function getCopiedEntries(self, object, serializationType, traversalDescription)
         local value = ____value[2]
         do
             if isSerializationBrand(nil, key) then
-                goto __continue78
+                goto __continue79
             end
             traversalDescription = getTraversalDescription(nil, key, traversalDescription)
             local newValue = ____exports.deepCopy(nil, value, serializationType, traversalDescription)
             local keyToUse = convertNumberKeysToStrings and tostring(key) or key
             copiedEntries[#copiedEntries + 1] = {keyToUse, newValue}
         end
-        ::__continue78::
+        ::__continue79::
     end
     return {entries = copiedEntries, convertedNumberKeysToStrings = convertNumberKeysToStrings}
 end
@@ -363,10 +372,10 @@ function checkMetatable(self, ____table, traversalDescription)
         return
     end
     local tableDescription = traversalDescription == "" and "the table to copy" or ("\"" .. traversalDescription) .. "\""
-    error(("The deepCopy function detected that \"" .. tableDescription) .. "\" has a metatable. Copying tables with metatables is not supported, unless they are explicitly handled by the save data manager. (e.g. TypeScriptToLua Maps, TypeScriptToLua Sets, etc.)")
+    error(("The deepCopy function detected that " .. tableDescription) .. " has a metatable. Copying tables with metatables is not supported, unless they are explicitly handled by the save data manager. (e.g. TypeScriptToLua Maps, TypeScriptToLua Sets, etc.)")
 end
 function deepCopyUserdata(self, value, serializationType, traversalDescription)
-    local classType = getIsaacAPIClassType(nil, value)
+    local classType = getIsaacAPIClassName(nil, value)
     if classType == nil then
         error("The deep copy function was not able to derive the Isaac API class type for: " .. traversalDescription)
     end

package/functions/deepCopyTests.lua

@@ -1,7 +1,6 @@
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
-local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 local Set = ____lualib.Set
 local ____exports = {}
 local copiedObjectIsTable, copiedObjectHasKeyAndValueString, copiedTableHasKeyAndValueNumber, copiedTableDoesNotCoerceTypes, copiedObjectHasNoReferencesForPrimitivesForward, copiedObjectHasNoReferencesForPrimitivesBackward, copiedObjectHasNoReferencesForArray, copiedObjectHasChildObject, copiedMapIsMap, copiedMapHasValue, copiedSetIsSet, copiedSetHasValue, copiedMapHasChildMap, copiedDefaultMapHasChildDefaultMap, copiedDefaultMapHasBrand
@@ -17,6 +16,10 @@ local ____deepCopy = require("functions.deepCopy")
 local deepCopy = ____deepCopy.deepCopy
 local ____log = require("functions.log")
 local log = ____log.log
+local ____tstlClass = require("functions.tstlClass")
+local isDefaultMap = ____tstlClass.isDefaultMap
+local isTSTLMap = ____tstlClass.isTSTLMap
+local isTSTLSet = ____tstlClass.isTSTLSet
 function copiedObjectIsTable(self)
     local oldObject = {abc = "def"}
     local newObject = deepCopy(nil, oldObject)
@@ -173,7 +176,7 @@ function copiedMapIsMap(self)
     if newMapType ~= "table" then
         error("The copied Map was not a table.")
     end
-    if not __TS__InstanceOf(newMap, Map) then
+    if not isTSTLMap(nil, newMap) then
         error("The copied Map was not a Map.")
     end
 end
@@ -202,7 +205,7 @@ function copiedSetIsSet(self)
     if newSetType ~= "table" then
         error("The copied Set was not a table.")
     end
-    if not __TS__InstanceOf(newSet, Set) then
+    if not isTSTLSet(nil, newSet) then
         error("The copied Set was not a Map.")
     end
 end
@@ -235,7 +238,7 @@ function copiedMapHasChildMap(self)
     if newChildMapType ~= "table" then
         error("The copied child Map had a type of: " .. newChildMapType)
     end
-    if not __TS__InstanceOf(newChildMap, Map) then
+    if not isTSTLMap(nil, newChildMap) then
         error("The copied child Map was not a Map.")
     end
     local value = newChildMap:get(childMapKey)
@@ -269,7 +272,7 @@ function copiedDefaultMapHasChildDefaultMap(self)
     if newChildMapType ~= "table" then
         error("The copied child DefaultMap had a type of: " .. newChildMapType)
     end
-    if not __TS__InstanceOf(newChildMap, DefaultMap) then
+    if not isDefaultMap(nil, newChildMap) then
         error("The copied child DefaultMap was not a DefaultMap.")
     end
     local newChildMapValue1 = newChildMap:get(childMapKey1)

package/functions/direction.d.ts

@@ -1,4 +1,12 @@
 import { Direction } from "isaac-typescript-definitions";
+/**
+ * Helper function to convert the degrees of an angle to the `Direction` enum.
+ *
+ * Note that this function considers 0 degrees to be pointing to the right, which is unusual because
+ * 0 normally corresponds to up. (This corresponds to how the `Vector.GetAngleDegrees` method
+ * works.)
+ */
+export declare function angleToDirection(angleDegrees: int): Direction;
 export declare function directionToDegrees(direction: Direction): int;
 export declare function directionToVector(direction: Direction): Vector;
 export declare function getDirectionName(direction: Direction): string | undefined;

package/functions/direction.lua

@@ -1,10 +1,37 @@
 local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local ____directionNames = require("objects.directionNames")
 local DIRECTION_NAMES = ____directionNames.DIRECTION_NAMES
 local ____directionToDegrees = require("objects.directionToDegrees")
 local DIRECTION_TO_DEGREES = ____directionToDegrees.DIRECTION_TO_DEGREES
 local ____directionToVector = require("objects.directionToVector")
 local DIRECTION_TO_VECTOR = ____directionToVector.DIRECTION_TO_VECTOR
+--- Helper function to convert the degrees of an angle to the `Direction` enum.
+-- 
+-- Note that this function considers 0 degrees to be pointing to the right, which is unusual because
+-- 0 normally corresponds to up. (This corresponds to how the `Vector.GetAngleDegrees` method
+-- works.)
+function ____exports.angleToDirection(self, angleDegrees)
+    local positiveDegrees = angleDegrees
+    while positiveDegrees < 0 do
+        positiveDegrees = positiveDegrees + 360
+    end
+    local normalizedDegrees = positiveDegrees % 360
+    if normalizedDegrees < 45 then
+        return Direction.RIGHT
+    end
+    if normalizedDegrees < 135 then
+        return Direction.DOWN
+    end
+    if normalizedDegrees < 225 then
+        return Direction.LEFT
+    end
+    if normalizedDegrees < 315 then
+        return Direction.UP
+    end
+    return Direction.RIGHT
+end
 function ____exports.directionToDegrees(self, direction)
     return DIRECTION_TO_DEGREES[direction]
 end

package/functions/doors.d.ts

@@ -45,6 +45,7 @@ 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 getOppositeDoorSlot(doorSlot: DoorSlot): DoorSlot | undefined;
 export declare function getRepentanceDoor(): GridEntityDoor | undefined;
 /** Helper function to find unused door slots in the room that can be used to make custom doors. */
 export declare function getUnusedDoorSlots(): DoorSlot[];

package/functions/doors.lua

@@ -18,6 +18,8 @@ local DEFAULT_DOOR_SLOT = ____doorSlotFlagToDoorSlot.DEFAULT_DOOR_SLOT
 local DOOR_SLOT_FLAG_TO_DOOR_SLOT = ____doorSlotFlagToDoorSlot.DOOR_SLOT_FLAG_TO_DOOR_SLOT
 local ____doorSlotToDirection = require("objects.doorSlotToDirection")
 local DOOR_SLOT_TO_DIRECTION = ____doorSlotToDirection.DOOR_SLOT_TO_DIRECTION
+local ____oppositeDoorSlots = require("objects.oppositeDoorSlots")
+local OPPOSITE_DOOR_SLOTS = ____oppositeDoorSlots.OPPOSITE_DOOR_SLOTS
 local ____roomShapeToDoorSlots = require("objects.roomShapeToDoorSlots")
 local ROOM_SHAPE_TO_DOOR_SLOTS = ____roomShapeToDoorSlots.ROOM_SHAPE_TO_DOOR_SLOTS
 local ____direction = require("functions.direction")
@@ -158,6 +160,9 @@ function ____exports.getDoorsToRoomIndex(self, ...)
         function(____, door) return roomGridIndexesSet:has(door.TargetRoomIndex) end
     )
 end
+function ____exports.getOppositeDoorSlot(self, doorSlot)
+    return OPPOSITE_DOOR_SLOTS[doorSlot]
+end
 function ____exports.getRepentanceDoor(self)
     local doors = ____exports.getDoors(nil)
     return __TS__ArrayFind(

package/functions/entity.d.ts

@@ -96,17 +96,17 @@ export declare function parseEntityTypeVariantString(entityTypeVariantString: st
  * @param entityVariant Optional. The variant to match. Default is -1. -1 matches every variant.
  * @param entitySubType Optional. The sub-type to match. Default is -1. -1 matches every sub-type.
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
- * @returns True if one or more entities were removed, false otherwise.
+ * @returns An array of the entities that were removed.
  */
-export declare function removeAllMatchingEntities(entityType: EntityType, entityVariant?: number, entitySubType?: number, cap?: int | undefined): boolean;
+export declare function removeAllMatchingEntities(entityType: EntityType, entityVariant?: number, entitySubType?: number, cap?: int | undefined): Entity[];
 /**
  * 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 were removed, false otherwise.
+ * @returns An array of the entities that were removed.
  */
-export declare function removeEntities(entities: Entity[], cap?: int): boolean;
+export declare function removeEntities<T extends AnyEntity>(entities: T[], cap?: int): T[];
 /**
  * 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/functions/entity.lua

@@ -18,20 +18,20 @@ local newRNG = ____rng.newRNG
 -- 
 -- @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 were removed, false otherwise.
+-- @returns An array of the entities that were removed.
 function ____exports.removeEntities(self, entities, cap)
     if #entities == 0 then
-        return false
+        return {}
     end
-    local numEntitiesRemoved = 0
+    local entitiesRemoved = {}
     for ____, entity in ipairs(entities) do
         entity:Remove()
-        numEntitiesRemoved = numEntitiesRemoved + 1
-        if cap ~= nil and numEntitiesRemoved >= cap then
-            return true
+        entitiesRemoved[#entitiesRemoved + 1] = entity
+        if cap ~= nil and #entitiesRemoved >= cap then
+            return entitiesRemoved
         end
     end
-    return true
+    return entitiesRemoved
 end
 --- 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
@@ -217,7 +217,7 @@ end
 -- @param entityVariant Optional. The variant to match. Default is -1. -1 matches every variant.
 -- @param entitySubType Optional. The sub-type to match. Default is -1. -1 matches every sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of collectibles.
--- @returns True if one or more entities were removed, false otherwise.
+-- @returns An array of the entities that were removed.
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
     if entityVariant == nil then
         entityVariant = -1