isaacscript-common 1.2.213 → 1.2.216

package/dist/constants.d.ts

@@ -37,6 +37,7 @@ export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: number;
 export declare const GAME_FRAMES_PER_SECOND = 30;
 export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
 export declare const ISAAC_FRAMES_PER_SECOND = 60;
+export declare const LEVEL_GRID_ROW_LENGTH = 13;
 /** In a 2x2 room, there can be 8 doors. */
 export declare const MAX_NUM_DOORS = 8;
 /**

package/dist/constants.lua

@@ -13,6 +13,7 @@ ____exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (1 << 32) - 1
 ____exports.GAME_FRAMES_PER_SECOND = 30
 ____exports.GRID_INDEX_CENTER_OF_1X1_ROOM = 67
 ____exports.ISAAC_FRAMES_PER_SECOND = 60
+____exports.LEVEL_GRID_ROW_LENGTH = 13
 ____exports.MAX_NUM_DOORS = 8
 ____exports.MAX_NUM_FAMILIARS = 64
 ____exports.MAX_NUM_INPUTS = 4

package/dist/functions/color.lua

@@ -8,9 +8,10 @@ local SerializationType = ____SerializationType.SerializationType
 local ____table = require("functions.table")
 local copyValuesToTable = ____table.copyValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
+local ____userdata = require("functions.userdata")
+local isUserdataObject = ____userdata.isUserdataObject
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
-local isUserdataObject = ____utils.isUserdataObject
 function ____exports.isColor(self, object)
     return isUserdataObject(nil, object, OBJECT_NAME)
 end

package/dist/functions/log.d.ts

@@ -16,9 +16,9 @@ export declare function logColor(this: void, color: Color): void;
 export declare function logDamageFlags(this: void, flags: int): void;
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
 export declare function logEntities(this: void, includeBackgroundEffects: boolean, entityTypeFilter?: EntityType | int): void;
-export declare function logEntity(this: void, entity: Entity): void;
 /** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
 export declare function logEntityFlags(this: void, flags: int): void;
+export declare function logEntityID(this: void, entity: Entity): void;
 /**
  * Helper function to log an error message and also print it to the console for better visibility.
  * This is useful in combination with an early return when invoking the `error` function would be
@@ -59,6 +59,11 @@ export declare function logTearFlags(this: void, flags: int): void;
 export declare function logTemporaryEffects(this: void, player: EntityPlayer): void;
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */
 export declare function logUseFlags(this: void, flags: int): void;
+/**
+ * Helper function to enumerate all of the properties of a "userdata" object (i.e. an object from
+ * the Isaac API).
+ */
+export declare function logUserdata(this: void, userdata: unknown): void;
 export declare function logVector(this: void, vector: Vector): void;
 /**
  * Converts every `isaacscript-common` function that begins with "log" to a global function.

package/dist/functions/log.lua

@@ -35,6 +35,8 @@ local ____set = require("functions.set")
 local getSortedSetValues = ____set.getSortedSetValues
 local ____trinkets = require("functions.trinkets")
 local getTrinketName = ____trinkets.getTrinketName
+local ____userdata = require("functions.userdata")
+local getUserdataType = ____userdata.getUserdataType
 local ____utils = require("functions.utils")
 local printConsole = ____utils.printConsole
 function ____exports.getDebugPrependString(self, msg, numParentFunctions)
@@ -190,12 +192,12 @@ function ____exports.logEntities(includeBackgroundEffects, entityTypeFilter)
         ____exports.log(("(" .. tostring(numMatchedEntities)) .. " total entities)")
     end
 end
-function ____exports.logEntity(entity)
-    ____exports.log((((("Entity: " .. tostring(entity.Type)) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType))
-end
 function ____exports.logEntityFlags(flags)
     ____exports.logFlags(flags, EntityFlag, "entity")
 end
+function ____exports.logEntityID(entity)
+    ____exports.log((((("Entity: " .. tostring(entity.Type)) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType))
+end
 function ____exports.logError(msg)
     local errorMsg = "Error: " .. msg
     ____exports.log(errorMsg)
@@ -379,7 +381,11 @@ function ____exports.logTable(____table, parentTables)
         ____exports.log((((indentation .. "Key: ") .. tostring(key)) .. ", Value: ") .. tostring(value))
         local valueType = type(value)
         if valueType == "table" then
-            ____exports.logTable(value, parentTables + 1)
+            if key == "__class" then
+                ____exports.log(indentation .. "(skipping enumerating this key to avoid infinite recursion)")
+            else
+                ____exports.logTable(value, parentTables + 1)
+            end
         end
         numKeys = numKeys + 1
     end
@@ -415,6 +421,25 @@ end
 function ____exports.logUseFlags(flags)
     ____exports.logFlags(flags, UseFlag, "use")
 end
+function ____exports.logUserdata(userdata)
+    local userdataType = type(userdata)
+    if userdataType ~= "userdata" then
+        ____exports.log("Userdata: [not userdata]")
+        return
+    end
+    local metatable = getmetatable(userdata)
+    if metatable == nil then
+        ____exports.log("Userdata: [no metatable]")
+        return
+    end
+    local classType = getUserdataType(nil, userdata)
+    if classType == nil then
+        ____exports.log("Userdata: [no class type]")
+    else
+        ____exports.log("Userdata: " .. classType)
+    end
+    ____exports.logTable(metatable)
+end
 function ____exports.logVector(vector)
     ____exports.log(((("Vector: (" .. tostring(vector.X)) .. ", ") .. tostring(vector.Y)) .. ")")
 end
@@ -425,7 +450,7 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logColor = ____exports.logColor
     globals.logDamageFlags = ____exports.logDamageFlags
     globals.logEntities = ____exports.logEntities
-    globals.logEntity = ____exports.logEntity
+    globals.logEntityID = ____exports.logEntityID
     globals.logEntityFlags = ____exports.logEntityFlags
     globals.logError = ____exports.logError
     globals.logFlags = ____exports.logFlags
@@ -443,6 +468,7 @@ function ____exports.setLogFunctionsGlobal(self)
     globals.logTearFlags = ____exports.logTearFlags
     globals.logTemporaryEffects = ____exports.logTemporaryEffects
     globals.logUseFlags = ____exports.logUseFlags
+    globals.logUserdata = ____exports.logUserdata
     globals.logVector = ____exports.logVector
 end
 return ____exports

package/dist/functions/npc.d.ts

@@ -49,6 +49,8 @@ export declare function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean;
  * enemies.
  */
 export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;
+/** Helper function to check if the provided NPC is a Sin miniboss, such as Sloth or Lust. */
+export declare function isSin(npc: EntityNPC): boolean;
 /**
  * Helper function to remove all NPCs in the room.
  *

package/dist/functions/npc.lua

@@ -7,6 +7,8 @@ local ____exports = {}
 local NON_ALIVE_NPCS_TYPE_VARIANT, NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE
 local ____constants = require("constants")
 local EGGY_STATE_FRAME_OF_FINAL_SPIDER = ____constants.EGGY_STATE_FRAME_OF_FINAL_SPIDER
+local ____sinEntityTypesSet = require("sets.sinEntityTypesSet")
+local SIN_ENTITY_TYPES_SET = ____sinEntityTypesSet.SIN_ENTITY_TYPES_SET
 local ____entity = require("functions.entity")
 local getEntities = ____entity.getEntities
 local getFilteredNewEntities = ____entity.getFilteredNewEntities
@@ -139,6 +141,9 @@ function ____exports.getBosses(self, matchingEntityType, matchingVariant, matchi
         function(____, npc) return npc:IsBoss() end
     )
 end
+function ____exports.isSin(self, npc)
+    return SIN_ENTITY_TYPES_SET:has(npc.Type)
+end
 function ____exports.removeAllNPCs(self, cap)
     local npcs = ____exports.getNPCs(nil)
     return removeEntities(nil, npcs, cap)

package/dist/functions/rng.lua

@@ -11,9 +11,10 @@ local SerializationType = ____SerializationType.SerializationType
 local ____table = require("functions.table")
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
+local ____userdata = require("functions.userdata")
+local isUserdataObject = ____userdata.isUserdataObject
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
-local isUserdataObject = ____utils.isUserdataObject
 function ____exports.getRandomSeed(self)
     local randomNumber = Random()
     local safeRandomNumber = randomNumber == 0 and 1 or randomNumber

package/dist/functions/rooms.d.ts

@@ -15,6 +15,13 @@ export declare function getAllRoomGridIndexes(): int[];
  * tricky to properly detect.
  */
 export declare function getCurrentDimension(): Dimension;
+/**
+ * Helper function to get the grid index delta that a door out of the given room shape would lead
+ * to. For example, if you went through the bottom door in a room of `RoomShape.ROOMSHAPE_1x2`, you
+ * would end up in a room with a grid index that is +26 units from the `SafeGridIndex` of where you
+ * started.
+ */
+export declare function getGridIndexDelta(roomShape: RoomShape, doorSlot: DoorSlot): int | undefined;
 /**
  * Helper function to get an array of all of the safe grid indexes for rooms that match the
  * specified room type.

package/dist/functions/rooms.lua

@@ -1,11 +1,11 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local Map = ____lualib.Map
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
-local Map = ____lualib.Map
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
@@ -13,6 +13,8 @@ local sfxManager = ____cachedClasses.sfxManager
 local ____constants = require("constants")
 local MAX_ROOM_INDEX = ____constants.MAX_ROOM_INDEX
 local NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
+local ____roomShapeToGridIndexDelta = require("objects.roomShapeToGridIndexDelta")
+local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
 local ____doors = require("functions.doors")
 local closeAllDoors = ____doors.closeAllDoors
 local getDoors = ____doors.getDoors
@@ -106,6 +108,13 @@ function ____exports.getCurrentDimension(self)
     end
     return error("Failed to get the current dimension using the starting room index of: " .. tostring(startingRoomGridIndex))
 end
+function ____exports.getGridIndexDelta(self, roomShape, doorSlot)
+    local doorSlotToGridIndexMap = ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
+    if doorSlotToGridIndexMap == nil then
+        return nil
+    end
+    return doorSlotToGridIndexMap:get(doorSlot)
+end
 function ____exports.getRoomGridIndexesForType(self, ...)
     local roomTypesSet = __TS__New(Set, {...})
     local rooms = ____exports.getRooms(nil)
@@ -246,12 +255,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue46
+                goto __continue48
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue46::
+        ::__continue48::
     end
     sfxManager:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/userdata.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Helper function to get the type of a userdata object from the Isaac API. This is contained within
+ * the "__type" metatable key.
+ *
+ * For example, a `Vector` class is userdata with a type of "Vector".
+ */
+export declare function getUserdataType(object: unknown): string | undefined;
+/**
+ * Helper function to check if something is an instantiated class from the Isaac API. (All classes
+ * from the Isaac API have a type of "userdata" in Lua with a metatable key of "__type".)
+ */
+export declare function isUserdataObject(object: unknown, objectType: string): boolean;

package/dist/functions/userdata.lua

@@ -0,0 +1,18 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+function ____exports.getUserdataType(self, object)
+    local objectType = type(object)
+    if objectType ~= "userdata" then
+        return nil
+    end
+    local metatable = getmetatable(object)
+    if metatable == nil then
+        return nil
+    end
+    return metatable.__type
+end
+function ____exports.isUserdataObject(self, object, objectType)
+    local userdataType = ____exports.getUserdataType(nil, object)
+    return userdataType == objectType or userdataType == "const " .. objectType
+end
+return ____exports

package/dist/functions/utils.d.ts

@@ -93,11 +93,6 @@ export declare function hexToKColor(hexString: string, alpha: float): KColor;
  * is enabled or not.
  */
 export declare function isLuaDebugEnabled(): boolean;
-/**
- * Helper function to check if the something is an instantiated class from the Isaac API. (All
- * classes from the Isaac API have a type of "userdata" in Lua.)
- */
-export declare function isUserdataObject(object: unknown, objectName: string): boolean;
 /**
  * Helper function to print something to the in-game console. Use this instead of invoking the
  * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end

package/dist/functions/utils.lua

@@ -66,18 +66,6 @@ end
 function ____exports.isLuaDebugEnabled(self)
     return package ~= nil
 end
-function ____exports.isUserdataObject(self, object, objectName)
-    local objectType = type(object)
-    if objectType ~= "userdata" then
-        return false
-    end
-    local metatable = getmetatable(object)
-    if metatable == nil then
-        return false
-    end
-    local vectorMetatable = metatable
-    return vectorMetatable.__type == objectName
-end
 function ____exports.printConsole(self, msg)
     Isaac.ConsoleOutput(msg .. "\n")
 end

package/dist/functions/vector.lua

@@ -11,9 +11,10 @@ local ____table = require("functions.table")
 local copyValuesToTable = ____table.copyValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
+local ____userdata = require("functions.userdata")
+local isUserdataObject = ____userdata.isUserdataObject
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
-local isUserdataObject = ____utils.isUserdataObject
 function ____exports.isVector(self, object)
     return isUserdataObject(nil, object, OBJECT_NAME)
 end

package/dist/index.d.ts

@@ -88,6 +88,7 @@ export * from "./functions/trinketGive";
 export * from "./functions/trinkets";
 export * from "./functions/trinketSet";
 export * from "./functions/ui";
+export * from "./functions/userdata";
 export * from "./functions/utils";
 export * from "./functions/vector";
 export * from "./maps/cardMap";

package/dist/index.lua

@@ -704,6 +704,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.userdata")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.utils")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/objects/roomShapeToGridIndexDelta.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Deltas are considered to be from the safe grid index of the room (i.e. the top left corner, or
+ * top right corner in the case of `RoomShape.ROOMSHAPE_LTL`).
+ */
+export declare const ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA: {
+    readonly [key in RoomShape]: Map<DoorSlot, int> | undefined;
+};

package/dist/objects/roomShapeToGridIndexDelta.lua

@@ -0,0 +1,85 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____constants = require("constants")
+local LEVEL_GRID_ROW_LENGTH = ____constants.LEVEL_GRID_ROW_LENGTH
+local LEFT = -1
+local UP = -LEVEL_GRID_ROW_LENGTH
+local RIGHT = 1
+local DOWN = LEVEL_GRID_ROW_LENGTH
+____exports.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = {
+    [RoomShape.ROOMSHAPE_1x1] = __TS__New(Map, {{DoorSlot.LEFT0, LEFT}, {DoorSlot.UP0, UP}, {DoorSlot.RIGHT0, RIGHT}, {DoorSlot.DOWN0, DOWN}}),
+    [RoomShape.ROOMSHAPE_IH] = __TS__New(Map, {{DoorSlot.LEFT0, LEFT}, {DoorSlot.RIGHT0, RIGHT}}),
+    [RoomShape.ROOMSHAPE_IV] = __TS__New(Map, {{DoorSlot.UP0, UP}, {DoorSlot.DOWN0, DOWN}}),
+    [RoomShape.ROOMSHAPE_1x2] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT},
+        {DoorSlot.DOWN0, DOWN + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT},
+        {DoorSlot.RIGHT1, DOWN + RIGHT}
+    }),
+    [RoomShape.ROOMSHAPE_IIV] = __TS__New(Map, {{DoorSlot.UP0, UP}, {DoorSlot.DOWN0, DOWN + DOWN}}),
+    [RoomShape.ROOMSHAPE_2x1] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT + RIGHT},
+        {DoorSlot.DOWN0, DOWN},
+        {DoorSlot.UP1, RIGHT + UP},
+        {DoorSlot.DOWN1, RIGHT + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_IIH] = __TS__New(Map, {{DoorSlot.LEFT0, LEFT}, {DoorSlot.RIGHT0, RIGHT + RIGHT}}),
+    [RoomShape.ROOMSHAPE_2x2] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT + RIGHT},
+        {DoorSlot.DOWN0, DOWN + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT},
+        {DoorSlot.UP1, RIGHT + UP},
+        {DoorSlot.RIGHT1, RIGHT + DOWN + RIGHT},
+        {DoorSlot.DOWN1, RIGHT + DOWN + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_LTL] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, DOWN + LEFT + UP},
+        {DoorSlot.RIGHT0, RIGHT},
+        {DoorSlot.DOWN0, DOWN + LEFT + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT + LEFT},
+        {DoorSlot.UP1, UP},
+        {DoorSlot.RIGHT1, DOWN + RIGHT},
+        {DoorSlot.DOWN1, DOWN + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_LTR] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT},
+        {DoorSlot.DOWN0, DOWN + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT},
+        {DoorSlot.UP1, DOWN + RIGHT + UP},
+        {DoorSlot.RIGHT1, DOWN + RIGHT + RIGHT},
+        {DoorSlot.DOWN1, DOWN + RIGHT + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_LBL] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT + RIGHT},
+        {DoorSlot.DOWN0, DOWN},
+        {DoorSlot.LEFT1, RIGHT + DOWN + LEFT},
+        {DoorSlot.UP1, RIGHT + UP},
+        {DoorSlot.RIGHT1, RIGHT + DOWN + RIGHT},
+        {DoorSlot.DOWN1, RIGHT + DOWN + DOWN}
+    }),
+    [RoomShape.ROOMSHAPE_LBR] = __TS__New(Map, {
+        {DoorSlot.LEFT0, LEFT},
+        {DoorSlot.UP0, UP},
+        {DoorSlot.RIGHT0, RIGHT + RIGHT},
+        {DoorSlot.DOWN0, DOWN + DOWN},
+        {DoorSlot.LEFT1, DOWN + LEFT},
+        {DoorSlot.UP1, RIGHT + UP},
+        {DoorSlot.RIGHT1, DOWN + RIGHT},
+        {DoorSlot.DOWN1, RIGHT + DOWN}
+    }),
+    [RoomShape.NUM_ROOMSHAPES] = nil
+}
+return ____exports

package/dist/sets/sinEntityTypesSet.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare const SIN_ENTITY_TYPES_SET: ReadonlySet<EntityType>;

package/dist/sets/sinEntityTypesSet.lua

@@ -0,0 +1,14 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+____exports.SIN_ENTITY_TYPES_SET = __TS__New(Set, {
+    EntityType.ENTITY_SLOTH,
+    EntityType.ENTITY_LUST,
+    EntityType.ENTITY_WRATH,
+    EntityType.ENTITY_GLUTTONY,
+    EntityType.ENTITY_GREED,
+    EntityType.ENTITY_ENVY,
+    EntityType.ENTITY_PRIDE
+})
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.213",
+  "version": "1.2.216",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -29,7 +29,7 @@
     "isaacscript-lint": "^1.0.95",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",
-    "typescript": "4.6.2",
+    "typescript": "4.6.3",
     "typescript-to-lua": "^1.4.2"
   }
 }