isaacscript-common 2.3.0 → 3.0.0

package/functions/gridEntity.lua

@@ -0,0 +1,368 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local Map = ____lualib.Map
+local ____exports = {}
+local getAllGridEntities
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.GridCollisionClass
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local PoopGridEntityVariant = ____isaac_2Dtypescript_2Ddefinitions.PoopGridEntityVariant
+local StatueVariant = ____isaac_2Dtypescript_2Ddefinitions.StatueVariant
+local TrapdoorVariant = ____isaac_2Dtypescript_2Ddefinitions.TrapdoorVariant
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("constants")
+local DISTANCE_OF_GRID_TILE = ____constants.DISTANCE_OF_GRID_TILE
+local ____gridEntityTypeToBrokenStateMap = require("maps.gridEntityTypeToBrokenStateMap")
+local GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP = ____gridEntityTypeToBrokenStateMap.GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP
+local ____gridEntityXMLMap = require("maps.gridEntityXMLMap")
+local GRID_ENTITY_XML_MAP = ____gridEntityXMLMap.GRID_ENTITY_XML_MAP
+local ____roomShapeToTopLeftWallGridIndexMap = require("maps.roomShapeToTopLeftWallGridIndexMap")
+local DEFAULT_TOP_LEFT_WALL_GRID_INDEX = ____roomShapeToTopLeftWallGridIndexMap.DEFAULT_TOP_LEFT_WALL_GRID_INDEX
+local ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = ____roomShapeToTopLeftWallGridIndexMap.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP
+local ____math = require("functions.math")
+local isCircleIntersectingRectangle = ____math.isCircleIntersectingRectangle
+local ____rooms = require("functions.rooms")
+local roomUpdateSafe = ____rooms.roomUpdateSafe
+local ____sprite = require("functions.sprite")
+local clearSprite = ____sprite.clearSprite
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
+local ____vector = require("functions.vector")
+local isVector = ____vector.isVector
+function getAllGridEntities(self)
+    local room = game:GetRoom()
+    local gridSize = room:GetGridSize()
+    local gridEntities = {}
+    for ____, gridIndex in ipairs(erange(nil, gridSize)) do
+        local gridEntity = room:GetGridEntity(gridIndex)
+        if gridEntity ~= nil then
+            gridEntities[#gridEntities + 1] = gridEntity
+        end
+    end
+    return gridEntities
+end
+--- Helper function to get the grid index of the top left wall. (This will depend on what the current
+-- room shape is.)
+function ____exports.getTopLeftWallGridIndex(self)
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    local topLeftWallGridIndex = ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP:get(roomShape)
+    return topLeftWallGridIndex == nil and DEFAULT_TOP_LEFT_WALL_GRID_INDEX or topLeftWallGridIndex
+end
+--- Helper function to remove a grid entity simply by providing the grid entity object.
+-- 
+-- @param gridEntity The grid entity to remove.
+-- @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
+-- Default is true. This is generally a good idea because if the room is not
+-- updated, you will be unable to spawn another grid entity on the same tile until
+-- a frame has passed. However, doing this is expensive, since it involves a call
+-- to `Isaac.GetRoomEntities`, so set it to false if you need to invoke this
+-- function multiple times.
+function ____exports.removeGrid(self, gridEntity, updateRoom)
+    if updateRoom == nil then
+        updateRoom = true
+    end
+    local room = game:GetRoom()
+    local gridIndex = gridEntity:GetGridIndex()
+    room:RemoveGridEntity(gridIndex, 0, false)
+    if updateRoom then
+        roomUpdateSafe(nil)
+    end
+end
+--- Helper function to spawn a grid entity with a specific variant.
+-- 
+-- Use this instead of the `Isaac.GridSpawn` method since it:
+-- - handles giving pits collision
+-- - removes existing grid entities on the same tile, if any
+-- - allows you to specify the grid index or the position
+function ____exports.spawnGridWithVariant(self, gridEntityType, variant, gridIndexOrPosition)
+    local room = game:GetRoom()
+    local ____isVector_result_0
+    if isVector(nil, gridIndexOrPosition) then
+        ____isVector_result_0 = room:GetGridEntityFromPos(gridIndexOrPosition)
+    else
+        ____isVector_result_0 = room:GetGridEntity(gridIndexOrPosition)
+    end
+    local existingGridEntity = ____isVector_result_0
+    if existingGridEntity ~= nil then
+        ____exports.removeGrid(nil, existingGridEntity)
+    end
+    local position = isVector(nil, gridIndexOrPosition) and gridIndexOrPosition or room:GetGridPosition(gridIndexOrPosition)
+    local gridEntity = Isaac.GridSpawn(gridEntityType, variant, position)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    if gridEntityType == GridEntityType.PIT then
+        local pit = gridEntity:ToPit()
+        if pit ~= nil then
+            pit:UpdateCollision()
+        end
+    elseif gridEntityType == GridEntityType.WALL then
+        gridEntity.CollisionClass = GridCollisionClass.WALL
+    end
+    return gridEntity
+end
+local BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS = __TS__New(Set, {
+    GridEntityType.ROCK,
+    GridEntityType.ROCK_TINTED,
+    GridEntityType.ROCK_BOMB,
+    GridEntityType.ROCK_ALT,
+    GridEntityType.SPIDER_WEB,
+    GridEntityType.TNT,
+    GridEntityType.POOP,
+    GridEntityType.ROCK_SUPER_SPECIAL,
+    GridEntityType.ROCK_SPIKED,
+    GridEntityType.ROCK_ALT_2,
+    GridEntityType.ROCK_GOLD
+})
+local BREAKABLE_GRID_ENTITY_TYPES_VARIANTS_BY_EXPLOSIONS = __TS__New(
+    Set,
+    {(tostring(GridEntityType.STATUE) .. ".") .. tostring(StatueVariant.ANGEL)}
+)
+--- Helper function to convert the grid entity type found in a room XML file to the corresponding
+-- grid entity type and variant normally used by the game. For example, a rock is represented as
+-- 1000.0 in a room XML file, but `GridEntityType.ROCK` is equal to 2.
+function ____exports.convertXMLGridEntityType(self, gridEntityXMLType, gridEntityXMLVariant)
+    local gridEntityArray = GRID_ENTITY_XML_MAP:get(gridEntityXMLType)
+    if gridEntityArray == nil then
+        error("Failed to find an entry in the grid entity map for XML entity type: " .. tostring(gridEntityXMLType))
+    end
+    local gridEntityType = gridEntityArray[1]
+    local gridEntityVariant = gridEntityArray[2]
+    if gridEntityType == GridEntityType.SPIKES_ON_OFF or gridEntityType == GridEntityType.PRESSURE_PLATE or gridEntityType == GridEntityType.TELEPORTER then
+        gridEntityVariant = gridEntityXMLVariant
+    end
+    return {gridEntityType, gridEntityVariant}
+end
+--- 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.
+function ____exports.getCollidingEntitiesWithGridEntity(self, gridEntity)
+    local gridEntityCollisionTopLeft = Vector(gridEntity.Position.X - DISTANCE_OF_GRID_TILE / 2, gridEntity.Position.Y - DISTANCE_OF_GRID_TILE / 2)
+    local gridEntityCollisionBottomRight = Vector(gridEntity.Position.X + DISTANCE_OF_GRID_TILE / 2, gridEntity.Position.Y + DISTANCE_OF_GRID_TILE / 2)
+    local closeEntities = Isaac.FindInRadius(gridEntity.Position, DISTANCE_OF_GRID_TILE * 2)
+    return __TS__ArrayFilter(
+        closeEntities,
+        function(____, entity) return entity:CollidesWithGrid() and isCircleIntersectingRectangle(
+            nil,
+            entity.Position,
+            entity.Size + 0.1,
+            gridEntityCollisionTopLeft,
+            gridEntityCollisionBottomRight
+        ) end
+    )
+end
+--- Helper function to get every grid entity in the current room.
+-- 
+-- Use this function with no arguments to get every grid entity, or specify a variadic amount of
+-- arguments to match specific grid entity types.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- for (const gridEntity of getGridEntities()) {
+--   print(gridEntity.GetType())
+-- }
+-- ```
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const rocks = getGridEntities(
+--   GridEntityType.ROCK,
+--   GridEntityType.BLOCK,
+--   GridEntityType.ROCK_TINTED,
+-- );
+-- ```
+function ____exports.getGridEntities(self, ...)
+    local gridEntityTypes = {...}
+    local gridEntities = getAllGridEntities(nil)
+    if #gridEntityTypes == 0 then
+        return gridEntities
+    end
+    local gridEntityTypesSet = __TS__New(Set, gridEntityTypes)
+    return __TS__ArrayFilter(
+        gridEntities,
+        function(____, gridEntity)
+            local gridEntityType = gridEntity:GetType()
+            return gridEntityTypesSet:has(gridEntityType)
+        end
+    )
+end
+--- Helper function to get a map of every grid entity in the current room. The indexes of the map are
+-- equal to the grid index. The values of the map are equal to the grid entities.
+-- 
+-- Use this function with no arguments to get every grid entity, or specify a variadic amount of
+-- arguments to match specific grid entity types.
+function ____exports.getGridEntitiesMap(self, ...)
+    local gridEntities = ____exports.getGridEntities(nil, ...)
+    local gridEntityMap = __TS__New(Map)
+    for ____, gridEntity in ipairs(gridEntities) do
+        local gridIndex = gridEntity:GetGridIndex()
+        gridEntityMap:set(gridIndex, gridEntity)
+    end
+    return gridEntityMap
+end
+--- Helper function to return a string containing the grid entity's type and variant.
+function ____exports.getGridEntityID(self, gridEntity)
+    local gridEntityType = gridEntity:GetType()
+    local gridEntityVariant = gridEntity:GetVariant()
+    return (tostring(gridEntityType) .. ".") .. tostring(gridEntityVariant)
+end
+function ____exports.getSurroundingGridEntities(self, gridEntity)
+    local room = game:GetRoom()
+    local gridWidth = room:GetGridWidth()
+    local gridIndex = gridEntity:GetGridIndex()
+    local surroundingGridIndexes = {
+        gridIndex - 1,
+        gridIndex + 1,
+        gridIndex - gridWidth - 1,
+        gridIndex - gridWidth,
+        gridIndex - gridWidth + 1,
+        gridIndex + gridWidth - 1,
+        gridIndex + gridWidth,
+        gridIndex + gridWidth + 1
+    }
+    local surroundingGridEntities = {}
+    for ____, surroundingGridIndex in ipairs(surroundingGridIndexes) do
+        local surroundingGridEntity = room:GetGridEntity(surroundingGridIndex)
+        if surroundingGridEntity ~= nil then
+            surroundingGridEntities[#surroundingGridEntities + 1] = surroundingGridEntity
+        end
+    end
+    return surroundingGridEntities
+end
+function ____exports.getTopLeftWall(self)
+    local room = game:GetRoom()
+    local topLeftWallGridIndex = ____exports.getTopLeftWallGridIndex(nil)
+    return room:GetGridEntity(topLeftWallGridIndex)
+end
+function ____exports.isGridEntityBreakableByExplosion(self, gridEntity)
+    local gridEntityType = gridEntity:GetType()
+    local gridEntityVariant = gridEntity:GetVariant()
+    local gridEntityTypeVariant = (tostring(gridEntityType) .. ".") .. tostring(gridEntityVariant)
+    return BREAKABLE_GRID_ENTITY_TYPES_BY_EXPLOSIONS:has(gridEntityType) or BREAKABLE_GRID_ENTITY_TYPES_VARIANTS_BY_EXPLOSIONS:has(gridEntityTypeVariant)
+end
+--- Helper function to see if the provided gridEntity is in its respective broken state. See the
+-- `GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP` constant for more details.
+-- 
+-- Note that in the case of `GridEntityType.LOCK` (11), the state will turn to being broken before
+-- the actual collision for the entity is removed.
+function ____exports.isGridEntityBroken(self, gridEntity)
+    local gridEntityType = gridEntity:GetType()
+    local brokenState = GRID_ENTITY_TYPE_TO_BROKEN_STATE_MAP:get(gridEntityType)
+    return gridEntity.State == brokenState
+end
+--- Helper function to detect whether a given Void Portal is one that randomly spawns after a boss is
+-- defeated or is one that naturally spawns in the room after Hush. (This is determined by looking
+-- at the VarData of the entity.)
+function ____exports.isPostBossVoidPortal(self, gridEntity)
+    local saveState = gridEntity:GetSaveState()
+    return saveState.VarData == 1
+end
+--- Helper function to all grid entities in the room except for ones matching the grid entity types
+-- provided.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- removeAllGridEntitiesExceptFor(
+--   GridEntityType.WALL,
+--   GridEntityType.DOOR,
+-- );
+-- ```
+-- 
+-- @returns True if one or more grid entities were removed, false otherwise.
+function ____exports.removeAllGridExcept(self, ...)
+    local gridEntityTypes = {...}
+    local gridEntityTypeExceptions = __TS__New(Set, gridEntityTypes)
+    local gridEntities = ____exports.getGridEntities(nil)
+    local removedOneOrMoreGridEntities = false
+    for ____, gridEntity in ipairs(gridEntities) do
+        local gridEntityType = gridEntity:GetType()
+        if not gridEntityTypeExceptions:has(gridEntityType) then
+            ____exports.removeGrid(nil, gridEntity, false)
+            removedOneOrMoreGridEntities = true
+        end
+    end
+    if removedOneOrMoreGridEntities then
+        roomUpdateSafe(nil)
+    end
+    return removedOneOrMoreGridEntities
+end
+--- Helper function to remove all of the grid entities in the room that match the grid entity types
+-- provided.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- removeAllMatchingGridEntities(
+--   GridEntityType.ROCK,
+--   GridEntityType.BLOCK,
+--   GridEntityType.ROCK_TINTED,
+-- );
+-- ```
+-- 
+-- @returns True if one or more grid entities were removed, false otherwise.
+function ____exports.removeAllMatchingGridEntities(self, ...)
+    local gridEntities = ____exports.getGridEntities(nil, ...)
+    if #gridEntities == 0 then
+        return false
+    end
+    for ____, gridEntity in ipairs(gridEntities) do
+        ____exports.removeGrid(nil, gridEntity, false)
+    end
+    roomUpdateSafe(nil)
+    return true
+end
+--- Helper function to make a grid entity invisible. This is accomplished by setting its sprite to an
+-- empty/missing PNG file.
+-- 
+-- For more information, see the documentation for the `clearSprite` helper function.
+function ____exports.setGridEntityInvisible(self, gridEntity)
+    local sprite = gridEntity:GetSprite()
+    clearSprite(nil, sprite)
+end
+--- Helper function to spawn a giant poop. This is performed by spawning each of the four quadrant
+-- grid entities in the appropriate positions.
+function ____exports.spawnGiantPoop(self, topLeftGridIndex)
+    local room = game:GetRoom()
+    local gridWidth = room:GetGridWidth()
+    local topRightGridIndex = topLeftGridIndex + 1
+    local bottomLeftGridIndex = topLeftGridIndex + gridWidth
+    local bottomRightGridIndex = bottomLeftGridIndex + 1
+    ____exports.spawnGridWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_TOP_LEFT, topLeftGridIndex)
+    ____exports.spawnGridWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_TOP_RIGHT, topRightGridIndex)
+    ____exports.spawnGridWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_BOTTOM_LEFT, bottomLeftGridIndex)
+    ____exports.spawnGridWithVariant(nil, GridEntityType.POOP, PoopGridEntityVariant.GIGA_BOTTOM_RIGHT, bottomRightGridIndex)
+end
+--- Helper function to spawn a grid entity.
+-- 
+-- This function assumes you want to give the grid entity a variant of 0. If you want to specify a
+-- variant, use the `spawnGridWithVariant` helper function instead.
+-- 
+-- Use this instead of the `Isaac.GridSpawn` method since it:
+-- - handles giving pits collision
+-- - removes existing grid entities on the same tile, if any
+-- - allows you to specify either the grid index or the position
+function ____exports.spawnGrid(self, gridEntityType, gridIndexOrPosition)
+    return ____exports.spawnGridWithVariant(nil, gridEntityType, 0, gridIndexOrPosition)
+end
+--- Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
+-- with the appropriate variant, as the game does not give it the correct sprite automatically.
+function ____exports.spawnVoidPortal(self, gridIndex)
+    local voidPortal = ____exports.spawnGridWithVariant(nil, GridEntityType.TRAPDOOR, TrapdoorVariant.VOID_PORTAL, gridIndex)
+    if voidPortal == nil then
+        return voidPortal
+    end
+    voidPortal.VarData = 1
+    local sprite = voidPortal:GetSprite()
+    sprite:Load("gfx/grid/voidtrapdoor.anm2", true)
+    return voidPortal
+end
+return ____exports

package/functions/gridEntitySpecific.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="isaac-typescript-definitions" />
+/** Helper function to get all of the `GridEntityPit` in the room. */
+export declare function getPits(): GridEntityPit[];
+/** Helper function to get all of the `GridEntityPoop` in the room. */
+export declare function getPoops(): GridEntityPoop[];
+/** Helper function to get all of the `GridEntityPressurePlate` in the room. */
+export declare function getPressurePlates(): GridEntityPressurePlate[];
+/** Helper function to get all of the `GridEntityRock` in the room. */
+export declare function getRocks(): GridEntityRock[];
+/** Helper function to get all of the `GridEntitySpikes` in the room. */
+export declare function getSpikes(): GridEntitySpikes[];
+/** Helper function to get all of the `GridEntityTNT` in the room. */
+export declare function getTNT(): GridEntityTNT[];
+/**
+ * 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.
+ */
+export declare function isAllPressurePlatesPushed(): boolean;

package/functions/gridEntitySpecific.lua

@@ -0,0 +1,96 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PressurePlateState = ____isaac_2Dtypescript_2Ddefinitions.PressurePlateState
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____gridEntity = require("functions.gridEntity")
+local getGridEntities = ____gridEntity.getGridEntities
+--- Helper function to get all of the `GridEntityPit` in the room.
+function ____exports.getPits(self)
+    local gridEntities = getGridEntities(nil)
+    local pits = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local pit = gridEntity:ToPit()
+        if pit ~= nil then
+            pits[#pits + 1] = pit
+        end
+    end
+    return pits
+end
+--- Helper function to get all of the `GridEntityPoop` in the room.
+function ____exports.getPoops(self)
+    local gridEntities = getGridEntities(nil)
+    local poops = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local poop = gridEntity:ToPoop()
+        if poop ~= nil then
+            poops[#poops + 1] = poop
+        end
+    end
+    return poops
+end
+--- Helper function to get all of the `GridEntityPressurePlate` in the room.
+function ____exports.getPressurePlates(self)
+    local gridEntities = getGridEntities(nil)
+    local pressurePlates = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local pressurePlate = gridEntity:ToPressurePlate()
+        if pressurePlate ~= nil then
+            pressurePlates[#pressurePlates + 1] = pressurePlate
+        end
+    end
+    return pressurePlates
+end
+--- Helper function to get all of the `GridEntityRock` in the room.
+function ____exports.getRocks(self)
+    local gridEntities = getGridEntities(nil)
+    local rocks = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local rock = gridEntity:ToRock()
+        if rock ~= nil then
+            rocks[#rocks + 1] = rock
+        end
+    end
+    return rocks
+end
+--- Helper function to get all of the `GridEntitySpikes` in the room.
+function ____exports.getSpikes(self)
+    local gridEntities = getGridEntities(nil)
+    local spikes = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local spike = gridEntity:ToSpikes()
+        if spike ~= nil then
+            spikes[#spikes + 1] = spike
+        end
+    end
+    return spikes
+end
+--- Helper function to get all of the `GridEntityTNT` in the room.
+function ____exports.getTNT(self)
+    local gridEntities = getGridEntities(nil)
+    local tntArray = {}
+    for ____, gridEntity in ipairs(gridEntities) do
+        local tnt = gridEntity:ToTNT()
+        if tnt ~= nil then
+            tntArray[#tntArray + 1] = tnt
+        end
+    end
+    return tntArray
+end
+--- 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.
+function ____exports.isAllPressurePlatesPushed(self)
+    local room = game:GetRoom()
+    local hasPressurePlates = room:HasTriggerPressurePlates()
+    if not hasPressurePlates then
+        return true
+    end
+    local pressurePlates = ____exports.getPressurePlates(nil)
+    return __TS__ArrayEvery(
+        pressurePlates,
+        function(____, pressurePlate) return pressurePlate.State == PressurePlateState.PRESSURE_PLATE_PRESSED end
+    )
+end
+return ____exports

package/functions/input.d.ts

@@ -0,0 +1,32 @@
+import { ButtonAction, Controller, Keyboard } from "isaac-typescript-definitions";
+/** Helper function to get the enum name for the specified `Controller` value. */
+export declare function controllerToString(controller: Controller): string;
+export declare function getMoveActions(): Set<ButtonAction>;
+export declare function getShootActions(): Set<ButtonAction>;
+/** Iterates over all inputs to determine if a particular button is pressed (i.e. held down). */
+export declare function isActionPressedOnAnyInput(buttonAction: ButtonAction): boolean;
+/**
+ * Iterates over all inputs to determine if a particular button is triggered (i.e. held down and
+ * then released).
+ */
+export declare function isActionTriggeredOnAnyInput(buttonAction: ButtonAction): boolean;
+/**
+ * Helper function to see if a particular keyboard key is being pressed down by the player.
+ *
+ * This function is variadic, meaning you can pass as many keyboard values as you want to check for.
+ * This function will return true if any of the values are pressed.
+ */
+export declare function isKeyboardPressed(...keys: Keyboard[]): boolean;
+/**
+ * Helper function to check if one or more modifier keys are being pressed down on the keyboard.
+ *
+ * A modifier key is defined as shift, control, alt, or Windows.
+ */
+export declare function isModifierKeyPressed(): boolean;
+export declare function isMoveAction(buttonAction: ButtonAction): boolean;
+export declare function isMoveActionPressedOnAnyInput(): boolean;
+export declare function isMoveActionTriggeredOnAnyInput(): boolean;
+export declare function isShootAction(buttonAction: ButtonAction): boolean;
+export declare function isShootActionPressedOnAnyInput(): boolean;
+export declare function isShootActionTriggeredOnAnyInput(): boolean;
+export declare function keyboardToString(keyboard: Keyboard): string;

package/functions/input.lua

@@ -0,0 +1,117 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ButtonAction = ____isaac_2Dtypescript_2Ddefinitions.ButtonAction
+local Controller = ____isaac_2Dtypescript_2Ddefinitions.Controller
+local ControllerIndex = ____isaac_2Dtypescript_2Ddefinitions.ControllerIndex
+local Keyboard = ____isaac_2Dtypescript_2Ddefinitions.Keyboard
+local ____constants = require("constants")
+local MAX_NUM_INPUTS = ____constants.MAX_NUM_INPUTS
+local ____set = require("functions.set")
+local copySet = ____set.copySet
+local ____string = require("functions.string")
+local trimPrefix = ____string.trimPrefix
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
+local MODIFIER_KEYS = {
+    Keyboard.LEFT_SHIFT,
+    Keyboard.LEFT_CONTROL,
+    Keyboard.LEFT_ALT,
+    Keyboard.LEFT_SUPER,
+    Keyboard.RIGHT_SHIFT,
+    Keyboard.RIGHT_CONTROL,
+    Keyboard.RIGHT_ALT,
+    Keyboard.RIGHT_SUPER
+}
+local MOVEMENT_ACTIONS = {ButtonAction.LEFT, ButtonAction.RIGHT, ButtonAction.UP, ButtonAction.DOWN}
+local MOVEMENT_ACTIONS_SET = __TS__New(Set, MOVEMENT_ACTIONS)
+local SHOOTING_ACTIONS = {ButtonAction.SHOOT_LEFT, ButtonAction.SHOOT_RIGHT, ButtonAction.SHOOT_UP, ButtonAction.SHOOT_DOWN}
+local SHOOTING_ACTIONS_SET = __TS__New(Set, SHOOTING_ACTIONS)
+--- Helper function to get the enum name for the specified `Controller` value.
+function ____exports.controllerToString(self, controller)
+    local key = Controller[controller]
+    if key == nil then
+        return "unknown"
+    end
+    return trimPrefix(nil, key, "BUTTON_")
+end
+function ____exports.getMoveActions(self)
+    return copySet(nil, MOVEMENT_ACTIONS_SET)
+end
+function ____exports.getShootActions(self)
+    return copySet(nil, SHOOTING_ACTIONS_SET)
+end
+--- Iterates over all inputs to determine if a particular button is pressed (i.e. held down).
+function ____exports.isActionPressedOnAnyInput(self, buttonAction)
+    local validInputs = erange(nil, MAX_NUM_INPUTS)
+    return __TS__ArraySome(
+        validInputs,
+        function(____, input) return Input.IsActionPressed(buttonAction, input) end
+    )
+end
+--- Iterates over all inputs to determine if a particular button is triggered (i.e. held down and
+-- then released).
+function ____exports.isActionTriggeredOnAnyInput(self, buttonAction)
+    local validInputs = erange(nil, MAX_NUM_INPUTS)
+    return __TS__ArraySome(
+        validInputs,
+        function(____, input) return Input.IsActionTriggered(buttonAction, input) end
+    )
+end
+--- Helper function to see if a particular keyboard key is being pressed down by the player.
+-- 
+-- This function is variadic, meaning you can pass as many keyboard values as you want to check for.
+-- This function will return true if any of the values are pressed.
+function ____exports.isKeyboardPressed(self, ...)
+    local keys = {...}
+    return __TS__ArraySome(
+        keys,
+        function(____, key) return Input.IsButtonPressed(key, ControllerIndex.KEYBOARD) end
+    )
+end
+--- Helper function to check if one or more modifier keys are being pressed down on the keyboard.
+-- 
+-- A modifier key is defined as shift, control, alt, or Windows.
+function ____exports.isModifierKeyPressed(self)
+    return ____exports.isKeyboardPressed(
+        nil,
+        table.unpack(MODIFIER_KEYS)
+    )
+end
+function ____exports.isMoveAction(self, buttonAction)
+    return MOVEMENT_ACTIONS_SET:has(buttonAction)
+end
+function ____exports.isMoveActionPressedOnAnyInput(self)
+    return __TS__ArraySome(
+        MOVEMENT_ACTIONS,
+        function(____, moveAction) return ____exports.isActionPressedOnAnyInput(nil, moveAction) end
+    )
+end
+function ____exports.isMoveActionTriggeredOnAnyInput(self)
+    return __TS__ArraySome(
+        MOVEMENT_ACTIONS,
+        function(____, moveAction) return ____exports.isActionTriggeredOnAnyInput(nil, moveAction) end
+    )
+end
+function ____exports.isShootAction(self, buttonAction)
+    return SHOOTING_ACTIONS_SET:has(buttonAction)
+end
+function ____exports.isShootActionPressedOnAnyInput(self)
+    return __TS__ArraySome(
+        SHOOTING_ACTIONS,
+        function(____, shootAction) return ____exports.isActionPressedOnAnyInput(nil, shootAction) end
+    )
+end
+function ____exports.isShootActionTriggeredOnAnyInput(self)
+    return __TS__ArraySome(
+        SHOOTING_ACTIONS,
+        function(____, shootAction) return ____exports.isActionTriggeredOnAnyInput(nil, shootAction) end
+    )
+end
+function ____exports.keyboardToString(self, keyboard)
+    return Keyboard[keyboard] or "unknown"
+end
+return ____exports

package/functions/isaacAPIClass.d.ts

@@ -0,0 +1,23 @@
+import { IsaacAPIClass } from "../types/private/IsaacAPIClass";
+/**
+ * Helper function to get the type of a class from the Isaac API. This is contained within the
+ * "__type" metatable key. In this context, the type of the class is equivalent to the name.
+ *
+ * For example, a `Vector` class is has a type of "Vector".
+ *
+ * Returns undefined if the object is not of type `userdata` or if the "__type" metatable key does
+ * not exist.
+ */
+export declare function getIsaacAPIClassType(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" equal to the
+ * name of the class.)
+ */
+export declare function isIsaacAPIClass(object: unknown): object is IsaacAPIClass;
+export declare function isIsaacAPIClassOfType(object: unknown, classType: string): boolean;
+/**
+ * Helper function to check if an instantiated Isaac API class is equal to another one of the same
+ * type. You must provide the list of keys to check for.
+ */
+export declare function isaacAPIClassEquals(object1: unknown, object2: unknown, keys: string[]): boolean;