isaacscript-common 2.3.0 → 3.0.0

package/features/deployJSONRoom.lua

@@ -0,0 +1,519 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local Map = ____lualib.Map
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local postNewRoom, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
+local EntityCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityCollisionClass
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local PitfallVariant = ____isaac_2Dtypescript_2Ddefinitions.PitfallVariant
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____entity = require("functions.entity")
+local removeAllMatchingEntities = ____entity.removeAllMatchingEntities
+local spawn = ____entity.spawn
+local spawnWithSeed = ____entity.spawnWithSeed
+local ____entitySpecific = require("functions.entitySpecific")
+local getNPCs = ____entitySpecific.getNPCs
+local removeAllBombs = ____entitySpecific.removeAllBombs
+local removeAllPickups = ____entitySpecific.removeAllPickups
+local ____gridEntity = require("functions.gridEntity")
+local convertXMLGridEntityType = ____gridEntity.convertXMLGridEntityType
+local getGridEntities = ____gridEntity.getGridEntities
+local removeAllGridExcept = ____gridEntity.removeAllGridExcept
+local setGridEntityInvisible = ____gridEntity.setGridEntityInvisible
+local spawnGridWithVariant = ____gridEntity.spawnGridWithVariant
+local ____jsonRoom = require("functions.jsonRoom")
+local getRandomJSONRoom = ____jsonRoom.getRandomJSONRoom
+local ____log = require("functions.log")
+local log = ____log.log
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+local newRNG = ____rng.newRNG
+local ____roomData = require("functions.roomData")
+local getRoomListIndex = ____roomData.getRoomListIndex
+local ____roomGrid = require("functions.roomGrid")
+local gridCoordinatesToWorldPosition = ____roomGrid.gridCoordinatesToWorldPosition
+local ____rooms = require("functions.rooms")
+local setRoomCleared = ____rooms.setRoomCleared
+local setRoomUncleared = ____rooms.setRoomUncleared
+local ____spawnCollectible = require("functions.spawnCollectible")
+local spawnCollectible = ____spawnCollectible.spawnCollectible
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postNewRoom(self)
+    local roomListIndex = getRoomListIndex(nil)
+    if not v.level.deployedRoomListIndexes:has(roomListIndex) then
+        return
+    end
+    setDecorationsInvisible(nil)
+    respawnPersistentEntities(nil)
+end
+function setDecorationsInvisible(self)
+    local room = game:GetRoom()
+    local roomListIndex = getRoomListIndex(nil)
+    local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
+    for ____, gridIndex in ipairs(decorationGridIndexes) do
+        local gridEntity = room:GetGridEntity(gridIndex)
+        if gridEntity ~= nil then
+            local gridEntityType = gridEntity:GetType()
+            if gridEntityType == GridEntityType.DECORATION then
+                setGridEntityInvisible(nil, gridEntity)
+            end
+        end
+    end
+end
+function respawnPersistentEntities(self)
+    local room = game:GetRoom()
+    local roomListIndex = getRoomListIndex(nil)
+    local persistentEntities = v.level.roomToPersistentEntitiesMap:getAndSetDefault(roomListIndex)
+    for ____, persistentEntity in ipairs(persistentEntities) do
+        local position = room:GetGridPosition(persistentEntity.gridIndex)
+        spawn(
+            nil,
+            persistentEntity.entityType,
+            persistentEntity.variant,
+            persistentEntity.subType,
+            position
+        )
+    end
+end
+--- Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
+-- this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
+-- (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
+-- effects (1000), doors, and walls.
+-- 
+-- @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
+-- decoration, which prevents vanilla entities in the room from
+-- respawning the next time that the player enters. Default is false.
+function ____exports.emptyRoom(self, fillWithDecorations)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local roomListIndex = getRoomListIndex(nil)
+    v.level.deployedRoomListIndexes:add(roomListIndex)
+    removeAllBombs(nil)
+    removeAllPickups(nil)
+    removeAllMatchingEntities(nil, EntityType.SLOT)
+    removeSpecificNPCs(nil)
+    removeAllMatchingEntities(nil, EntityType.EFFECT, EffectVariant.DEVIL)
+    removeAllMatchingEntities(nil, EntityType.EFFECT, EffectVariant.ANGEL)
+    removeAllGridExcept(nil, GridEntityType.WALL, GridEntityType.DOOR)
+    setRoomCleared(nil)
+    if fillWithDecorations then
+        fillRoomWithDecorations(nil)
+    end
+end
+function removeSpecificNPCs(self)
+    local room = game:GetRoom()
+    for ____, npc in ipairs(getNPCs(nil)) do
+        do
+            if NPC_TYPES_TO_NOT_REMOVE:has(npc.Type) then
+                goto __continue25
+            end
+            if npc:HasEntityFlags(EntityFlag.CHARM) or npc:HasEntityFlags(EntityFlag.FRIENDLY) or npc:HasEntityFlags(EntityFlag.PERSISTENT) then
+                goto __continue25
+            end
+            npc:ClearEntityFlags(EntityFlag.APPEAR)
+            npc:Remove()
+            if npc.Type == EntityType.FIREPLACE then
+                local gridIndex = room:GetGridIndex(npc.Position)
+                room:SetGridPath(gridIndex, 0)
+            end
+        end
+        ::__continue25::
+    end
+end
+function fillRoomWithDecorations(self)
+    local room = game:GetRoom()
+    local gridSize = room:GetGridSize()
+    local roomListIndex = getRoomListIndex(nil)
+    local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
+    for ____, gridIndex in ipairs(erange(nil, gridSize)) do
+        do
+            local existingGridEntity = room:GetGridEntity(gridIndex)
+            if existingGridEntity ~= nil then
+                goto __continue31
+            end
+            local position = room:GetGridPosition(gridIndex)
+            local decoration = Isaac.GridSpawn(GridEntityType.DECORATION, 0, position)
+            if decoration ~= nil then
+                setGridEntityInvisible(nil, decoration)
+            end
+            decorationGridIndexes[#decorationGridIndexes + 1] = gridIndex
+        end
+        ::__continue31::
+    end
+end
+function spawnAllEntities(self, jsonRoom, rng, verbose)
+    if verbose == nil then
+        verbose = false
+    end
+    local shouldUnclearRoom = false
+    for ____, jsonSpawn in ipairs(jsonRoom.spawn) do
+        local xString = jsonSpawn["$"].x
+        local x = tonumber(xString)
+        if x == nil then
+            error("Failed to convert the following x coordinate to a number (for a spawn): " .. xString)
+        end
+        local yString = jsonSpawn["$"].y
+        local y = tonumber(yString)
+        if y == nil then
+            error("Failed to convert the following y coordinate to a number (for a spawn): " .. yString)
+        end
+        if #jsonSpawn.entity > 1 then
+            error("Stacked entities are not implemented for JSON rooms.")
+        end
+        local firstXMLEntity = jsonSpawn.entity[1]
+        if firstXMLEntity == nil then
+            error("Failed to get the first JSON entity from an \"entity\" array.")
+        end
+        local entityTypeString = firstXMLEntity["$"].type
+        local entityType = tonumber(entityTypeString)
+        if entityType == nil then
+            error("Failed to convert the entity type to a number: " .. entityTypeString)
+        end
+        local variantString = firstXMLEntity["$"].variant
+        local variant = tonumber(variantString)
+        if variant == nil then
+            error("Failed to convert the entity variant to a number: " .. tostring(variant))
+        end
+        local subTypeString = firstXMLEntity["$"].subtype
+        local subType = tonumber(subTypeString)
+        if subType == nil then
+            error("Failed to convert the entity sub-type to a number: " .. tostring(subType))
+        end
+        if entityType >= 1000 then
+            if verbose then
+                log(((((((("Spawning grid entity " .. tostring(entityType)) .. ".") .. tostring(variant)) .. " at: (") .. tostring(x)) .. ", ") .. tostring(y)) .. ")")
+            end
+            spawnGridEntityForJSONRoom(
+                nil,
+                entityType,
+                variant,
+                x,
+                y
+            )
+        else
+            if verbose then
+                log(((((((((("Spawning normal entity " .. tostring(entityType)) .. ".") .. tostring(variant)) .. ".") .. tostring(subType)) .. " at: (") .. tostring(x)) .. ", ") .. tostring(y)) .. ")")
+            end
+            local entity = spawnNormalEntityForJSONRoom(
+                nil,
+                entityType,
+                variant,
+                subType,
+                x,
+                y,
+                rng
+            )
+            local npc = entity:ToNPC()
+            if npc ~= nil and npc.CanShutDoors then
+                shouldUnclearRoom = true
+            end
+        end
+    end
+    if shouldUnclearRoom then
+        if verbose then
+            log("Setting the room to be uncleared since there were one or more battle NPCs spawned.")
+        end
+        setRoomUncleared(nil)
+    elseif verbose then
+        log("Leaving the room cleared since there were no battle NPCs spawned.")
+    end
+end
+function spawnGridEntityForJSONRoom(self, gridEntityXMLType, gridEntityXMLVariant, x, y)
+    local room = game:GetRoom()
+    local gridEntityTuple = convertXMLGridEntityType(nil, gridEntityXMLType, gridEntityXMLVariant)
+    if gridEntityTuple == nil then
+        return nil
+    end
+    local gridEntityType, variant = table.unpack(gridEntityTuple)
+    local position = gridCoordinatesToWorldPosition(nil, x, y)
+    local gridIndex = room:GetGridIndex(position)
+    local gridEntity = spawnGridWithVariant(nil, gridEntityType, variant, gridIndex)
+    if gridEntity == nil then
+        return gridEntity
+    end
+    if gridEntityType == GridEntityType.POOP then
+        local sprite = gridEntity:GetSprite()
+        sprite:Play("State1", true)
+        sprite:SetLastFrame()
+    end
+    return gridEntity
+end
+function spawnNormalEntityForJSONRoom(self, entityType, variant, subType, x, y, rng)
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local position = gridCoordinatesToWorldPosition(nil, x, y)
+    local seed = rng:Next()
+    local entity
+    if entityType == EntityType.PICKUP and variant == PickupVariant.COLLECTIBLE then
+        local options = roomType == RoomType.ANGEL
+        entity = spawnCollectible(
+            nil,
+            subType,
+            position,
+            seed,
+            options
+        )
+    else
+        entity = spawnWithSeed(
+            nil,
+            entityType,
+            variant,
+            subType,
+            position,
+            seed
+        )
+    end
+    if entityType == EntityType.PITFALL and variant == PitfallVariant.PITFALL then
+        entity.EntityCollisionClass = EntityCollisionClass.ENEMIES
+        entity.GridCollisionClass = EntityGridCollisionClass.WALLS
+    end
+    storePersistentEntity(nil, entity)
+    return entity
+end
+function storePersistentEntity(self, entity)
+    if not PERSISTENT_ENTITY_TYPES:has(entity.Type) then
+        return
+    end
+    local room = game:GetRoom()
+    local gridIndex = room:GetGridIndex(entity.Position)
+    local roomListIndex = getRoomListIndex(nil)
+    local persistentEntity = {gridIndex = gridIndex, entityType = entity.Type, variant = entity.Variant, subType = entity.SubType}
+    local persistentEntities = v.level.roomToPersistentEntitiesMap:getAndSetDefault(roomListIndex)
+    persistentEntities[#persistentEntities + 1] = persistentEntity
+end
+function fixPitGraphics(self)
+    local room = game:GetRoom()
+    local gridWidth = room:GetGridWidth()
+    local pitMap = getPitMap(nil)
+    for ____, ____value in __TS__Iterator(pitMap:entries()) do
+        local gridIndex = ____value[1]
+        local gridEntity = ____value[2]
+        local gridIndexLeft = gridIndex - 1
+        local L = pitMap:has(gridIndexLeft)
+        local gridIndexRight = gridIndex + 1
+        local R = pitMap:has(gridIndexRight)
+        local gridIndexUp = gridIndex - gridWidth
+        local U = pitMap:has(gridIndexUp)
+        local gridIndexDown = gridIndex + gridWidth
+        local D = pitMap:has(gridIndexDown)
+        local gridIndexUpLeft = gridIndex - gridWidth - 1
+        local UL = pitMap:has(gridIndexUpLeft)
+        local gridIndexUpRight = gridIndex - gridWidth + 1
+        local UR = pitMap:has(gridIndexUpRight)
+        local gridIndexDownLeft = gridIndex + gridWidth - 1
+        local DL = pitMap:has(gridIndexDownLeft)
+        local gridIndexDownRight = gridIndex + gridWidth + 1
+        local DR = pitMap:has(gridIndexDownRight)
+        local pitFrame = getPitFrame(
+            nil,
+            L,
+            R,
+            U,
+            D,
+            UL,
+            UR,
+            DL,
+            DR
+        )
+        local sprite = gridEntity:GetSprite()
+        sprite:SetFrame(pitFrame)
+    end
+end
+function getPitMap(self)
+    local pitMap = __TS__New(Map)
+    for ____, gridEntity in ipairs(getGridEntities(nil, GridEntityType.PIT)) do
+        local gridIndex = gridEntity:GetGridIndex()
+        pitMap:set(gridIndex, gridEntity)
+    end
+    return pitMap
+end
+function getPitFrame(self, L, R, U, D, UL, UR, DL, DR)
+    local F = 0
+    if L then
+        F = F | 1
+    end
+    if U then
+        F = F | 2
+    end
+    if R then
+        F = F | 4
+    end
+    if D then
+        F = F | 8
+    end
+    if U and L and not UL and not R and not D then
+        F = 17
+    end
+    if U and R and not UR and not L and not D then
+        F = 18
+    end
+    if L and D and not DL and not U and not R then
+        F = 19
+    end
+    if R and D and not DR and not L and not U then
+        F = 20
+    end
+    if L and U and R and D and not UL then
+        F = 21
+    end
+    if L and U and R and D and not UR then
+        F = 22
+    end
+    if U and R and D and not L and not UR then
+        F = 25
+    end
+    if L and U and D and not R and not UL then
+        F = 26
+    end
+    if L and U and R and D and not DL and not DR then
+        F = 24
+    end
+    if L and U and R and D and not UR and not UL then
+        F = 23
+    end
+    if L and U and R and UL and not UR and not D then
+        F = 27
+    end
+    if L and U and R and UR and not UL and not D then
+        F = 28
+    end
+    if L and U and R and not D and not UR and not UL then
+        F = 29
+    end
+    if L and R and D and DL and not U and not DR then
+        F = 30
+    end
+    if L and R and D and DR and not U and not DL then
+        F = 31
+    end
+    if L and R and D and not U and not DL and not DR then
+        F = 32
+    end
+    return F
+end
+FEATURE_NAME = "JSON room deployer"
+NPC_TYPES_TO_NOT_REMOVE = __TS__New(Set, {EntityType.DARK_ESAU})
+PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
+v = {level = {
+    deployedRoomListIndexes = __TS__New(Set),
+    roomToPersistentEntitiesMap = __TS__New(
+        DefaultMap,
+        function() return {} end
+    ),
+    roomToDecorationGridIndexesMap = __TS__New(
+        DefaultMap,
+        function() return {} end
+    )
+}}
+---
+-- @internal
+function ____exports.deployJSONRoomInit(self, mod)
+    saveDataManager(nil, "deployJSONRoom", v)
+    mod:AddCallback(ModCallback.POST_NEW_ROOM, postNewRoom)
+end
+--- Helper function to deconstruct a vanilla room and set up a custom room in its place.
+-- Specifically, this will clear the current room of all entities and grid entities, and then spawn
+-- all of the entries and grid entities in the provided JSON room.
+-- 
+-- This function is meant to be used in the PostNewRoom callback.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- 
+-- import customRooms from "./customRooms";
+-- 
+-- const firstJSONRoom = customRooms.rooms.room[0];
+-- deployJSONRoom(firstJSONRoom);
+-- ```
+-- 
+-- @param jsonRoom The JSON room to deploy. *
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+-- what the function is doing. Default is false.
+function ____exports.deployJSONRoom(self, jsonRoom, seedOrRNG, verbose)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if verbose == nil then
+        verbose = false
+    end
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
+    if verbose then
+        log("Starting to empty the room of entities and grid entities.")
+    end
+    ____exports.emptyRoom(nil, false)
+    if verbose then
+        log("Finished emptying the room of entities and grid entities.")
+    end
+    if verbose then
+        log("Starting to spawn all of the new entities and grid entities.")
+    end
+    spawnAllEntities(nil, jsonRoom, rng, verbose)
+    if verbose then
+        log("Finished spawning all of the new entities and grid entities.")
+    end
+    fixPitGraphics(nil)
+    fillRoomWithDecorations(nil)
+end
+--- Helper function to deconstruct a vanilla room and set up a custom room in its place.
+-- Specifically, this will clear the current room of all entities and grid entities, and then spawn
+-- all of the entries and grid entities in one of the provided JSON rooms.
+-- 
+-- This function is meant to be used in the PostNewRoom callback.
+-- 
+-- Note that this function does not simply choose a random element in the provided array; it will
+-- properly account for each room weight using the algorithm from:
+-- https://stackoverflow.com/questions/1761626/weighted-random-numbers
+-- 
+-- For example:
+-- 
+-- ```ts
+-- import customRooms from "./customRooms";
+-- 
+-- const jsonRooms = customRooms.rooms.room;
+-- deployRandomJSONRoom(jsonRooms);
+-- ```
+-- 
+-- @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be
+-- something like.
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+-- what the function is doing. Default is false.
+function ____exports.deployRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if verbose == nil then
+        verbose = false
+    end
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
+    local randomJSONRoom = getRandomJSONRoom(nil, jsonRooms, rng, verbose)
+    if verbose then
+        log((((((("Randomly chose JSON room " .. randomJSONRoom["$"].type) .. ".") .. randomJSONRoom["$"].variant) .. ".") .. randomJSONRoom["$"].subtype) .. " with name: ") .. randomJSONRoom["$"].name)
+    end
+    return ____exports.deployJSONRoom(nil, randomJSONRoom, rng, verbose)
+end
+return ____exports

package/features/disableInputs.d.ts

@@ -0,0 +1,62 @@
+import { ButtonAction } from "isaac-typescript-definitions";
+/**
+ * Helper function to enable all inputs. Use this function to set things back to normal after having
+ * used one of the other helper functions to disable inputs.
+ *
+ * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+ *            that multiple mod features can work in tandem.
+ */
+export declare function enableAllInputs(key: string): void;
+/**
+ * Helper function to disable all inputs. This is useful because `EntityPlayer.ControlsEnabled` can
+ * be changed by the game under certain conditions.
+ *
+ * Use the `enableAllInputs` helper function to set things back to normal.
+ *
+ * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+ *            that multiple mod features can work in tandem.
+ */
+export declare function disableAllInputs(key: string): void;
+/**
+ * Helper function to enable all inputs besides the ones provided. This is useful because
+ * `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
+ *
+ * Use the `enableAllInputs` helper function to set things back to normal.
+ *
+ * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+ *            that multiple mod features can work in tandem.
+ * @param blacklist A set of ButtonActions to disallow.
+ */
+export declare function enableAllInputsExceptFor(key: string, blacklist: Set<ButtonAction> | ReadonlySet<ButtonAction>): void;
+/**
+ * Helper function to disable all inputs besides the ones provided. This is useful because
+ * `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
+ *
+ * Use the `enableAllInputs` helper function to set things back to normal.
+ *
+ * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+ *            that multiple mod features can work in tandem.
+ * @param whitelist A set of ButtonActions to allow.
+ */
+export declare function disableAllInputsExceptFor(key: string, whitelist: Set<ButtonAction>): void;
+/**
+ * Helper function to disable only the inputs used for moving the character (or moving the cursor in
+ * the UI). This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under
+ * certain conditions.
+ *
+ * Use the `enableAllInputs` helper function to set things back to normal.
+ *
+ * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+ *            that multiple mod features can work in tandem.
+ */
+export declare function disableMovementInputs(key: string): void;
+/**
+ * Helper function to disable only the inputs used for shooting tears. This is useful because
+ * `EntityPlayer.ControlsEnabled` can be changed by the game under certain conditions.
+ *
+ * Use the `enableAllInputs` helper function to set things back to normal.
+ *
+ * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
+ *            that multiple mod features can work in tandem.
+ */
+export declare function disableShootingInputs(key: string): void;