isaacscript-common 5.1.3 → 6.0.0

package/constants.d.ts

@@ -34,9 +34,11 @@ export declare const EMPTY_PNG_PATH = "gfx/none.png";
  * second TMTRAINER item subtracts one from that, and so on.
  */
 export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: CollectibleType;
+/** Game frames are what is returned by the `Game.GetFrameCount` method. */
 export declare const GAME_FRAMES_PER_SECOND = 30;
+/** Render frames are what is returned by the `Isaac.GetFrameCount` method. */
+export declare const RENDER_FRAMES_PER_SECOND = 60;
 export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
-export declare const ISAAC_FRAMES_PER_SECOND = 60;
 /**
  * The floor is represented by a 13x13 grid. Room indexes start at 0. The first column is
  * represented by grid indexes 0, 13, 26, and so on.

package/constants.lua

@@ -35,9 +35,11 @@ ____exports.EMPTY_PNG_PATH = "gfx/none.png"
 -- encountered by the player. The first TMTRAINER item takes the final possible 32 bit number. The
 -- second TMTRAINER item subtracts one from that, and so on.
 ____exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (1 << 32) - 1
+--- Game frames are what is returned by the `Game.GetFrameCount` method.
 ____exports.GAME_FRAMES_PER_SECOND = 30
+--- Render frames are what is returned by the `Isaac.GetFrameCount` method.
+____exports.RENDER_FRAMES_PER_SECOND = 60
 ____exports.GRID_INDEX_CENTER_OF_1X1_ROOM = 67
-____exports.ISAAC_FRAMES_PER_SECOND = 60
 --- The floor is represented by a 13x13 grid. Room indexes start at 0. The first column is
 -- represented by grid indexes 0, 13, 26, and so on.
 ____exports.LEVEL_GRID_COLUMN_HEIGHT = 13

package/features/registerHotkey.d.ts

@@ -1,3 +1,22 @@
 import { Keyboard } from "isaac-typescript-definitions";
-export declare function registerHotkey(keyboard: Keyboard, func: () => void): void;
-export declare function unregisterHotkey(keyboard: Keyboard): void;
+/**
+ * Helper function to run arbitrary code when you press and release a specific keyboard key.
+ *
+ * This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
+ * in debugging.
+ *
+ * @param keyboardOrFunc Either the key that you want to trigger the hotkey or a function that
+ *                       returns the key that will trigger the hotkey. Normally, you would just
+ *                       specify the key directly, but you can use a function for situations where
+ *                       the key can change (like if end-users can specify a custom hotkey using Mod
+ *                       Config Menu).
+ * @param triggerFunc A function containing the arbitrary code that you want to execute when the
+ *                    hotkey is triggered.
+ */
+export declare function registerHotkey(keyboardOrFunc: Keyboard | (() => Keyboard | undefined), triggerFunc: () => void): void;
+/**
+ * Helper function to remove a hotkey created with the `registerHotkey` function.
+ *
+ * @param keyboardOrFunc Equal to the value that you passed when initially registering the hotkey.
+ */
+export declare function unregisterHotkey(keyboardOrFunc: Keyboard | (() => Keyboard | undefined)): void;

package/features/registerHotkey.lua

@@ -3,7 +3,7 @@ local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local postRender, hotkeyFunctionMap, keyPressedMap
+local postRender, checkIfTriggered, staticHotkeyFunctionMap, dynamicHotkeyFunctionMap, keyPressedMap
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local Keyboard = ____isaac_2Dtypescript_2Ddefinitions.Keyboard
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
@@ -13,38 +13,81 @@ local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
 local ____input = require("functions.input")
 local isKeyboardPressed = ____input.isKeyboardPressed
+local ____types = require("functions.types")
+local isFunction = ____types.isFunction
 function postRender(self)
-    for ____, ____value in __TS__Iterator(hotkeyFunctionMap:entries()) do
+    for ____, ____value in __TS__Iterator(staticHotkeyFunctionMap:entries()) do
         local keyboard = ____value[1]
-        local func = ____value[2]
-        local isPressed = isKeyboardPressed(nil, keyboard)
-        local wasPreviouslyPressed = keyPressedMap:getAndSetDefault(keyboard)
-        keyPressedMap:set(keyboard, isPressed)
-        if isPressed and not wasPreviouslyPressed then
-            func(nil)
+        local triggerFunc = ____value[2]
+        checkIfTriggered(nil, keyboard, triggerFunc)
+    end
+    for ____, ____value in __TS__Iterator(dynamicHotkeyFunctionMap:entries()) do
+        local keyboardFunc = ____value[1]
+        local triggerFunc = ____value[2]
+        local keyboard = keyboardFunc(nil)
+        if keyboard ~= nil then
+            checkIfTriggered(nil, keyboard, triggerFunc)
         end
     end
 end
+function checkIfTriggered(self, keyboard, triggerFunc)
+    local isPressed = isKeyboardPressed(nil, keyboard)
+    local wasPreviouslyPressed = keyPressedMap:getAndSetDefault(keyboard)
+    keyPressedMap:set(keyboard, isPressed)
+    if isPressed and not wasPreviouslyPressed then
+        triggerFunc(nil)
+    end
+end
 local FEATURE_NAME = "registerHotkeys"
-hotkeyFunctionMap = __TS__New(Map)
+staticHotkeyFunctionMap = __TS__New(Map)
+dynamicHotkeyFunctionMap = __TS__New(Map)
 keyPressedMap = __TS__New(DefaultMap, false)
 ---
 -- @internal
 function ____exports.registerHotkeyInit(self, mod)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end
-function ____exports.registerHotkey(self, keyboard, func)
+--- Helper function to run arbitrary code when you press and release a specific keyboard key.
+-- 
+-- This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
+-- in debugging.
+-- 
+-- @param keyboardOrFunc Either the key that you want to trigger the hotkey or a function that
+-- returns the key that will trigger the hotkey. Normally, you would just
+-- specify the key directly, but you can use a function for situations where
+-- the key can change (like if end-users can specify a custom hotkey using Mod
+-- Config Menu).
+-- @param triggerFunc A function containing the arbitrary code that you want to execute when the
+-- hotkey is triggered.
+function ____exports.registerHotkey(self, keyboardOrFunc, triggerFunc)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
-    if hotkeyFunctionMap:has(keyboard) then
-        error(((("Failed to register a hotkey for key Keyboard." .. tostring(Keyboard[keyboard])) .. " (") .. tostring(keyboard)) .. ") due to a custom hotkey already being defined for that key.")
+    if isFunction(nil, keyboardOrFunc) then
+        if dynamicHotkeyFunctionMap:has(keyboardOrFunc) then
+            error("Failed to register a hotkey due to a custom hotkey already being defined for the submitted function.")
+        end
+        dynamicHotkeyFunctionMap:set(keyboardOrFunc, triggerFunc)
+    else
+        if staticHotkeyFunctionMap:has(keyboardOrFunc) then
+            error(((("Failed to register a hotkey due to a hotkey already being defined for key: Keyboard." .. tostring(Keyboard[keyboardOrFunc])) .. " (") .. tostring(keyboardOrFunc)) .. ")")
+        end
+        staticHotkeyFunctionMap:set(keyboardOrFunc, triggerFunc)
     end
-    hotkeyFunctionMap:set(keyboard, func)
 end
-function ____exports.unregisterHotkey(self, keyboard)
+--- Helper function to remove a hotkey created with the `registerHotkey` function.
+-- 
+-- @param keyboardOrFunc Equal to the value that you passed when initially registering the hotkey.
+function ____exports.unregisterHotkey(self, keyboardOrFunc)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
-    if not hotkeyFunctionMap:has(keyboard) then
-        error(((("Failed to unregister a hotkey for key Keyboard." .. tostring(Keyboard[keyboard])) .. " (") .. tostring(keyboard)) .. ") due to no function being defined for that key.")
+    if isFunction(nil, keyboardOrFunc) then
+        if not dynamicHotkeyFunctionMap:has(keyboardOrFunc) then
+            error("Failed to unregister a hotkey since there is no existing hotkey defined for the submitted function.")
+        end
+        dynamicHotkeyFunctionMap:delete(keyboardOrFunc)
+    else
+        if not staticHotkeyFunctionMap:has(keyboardOrFunc) then
+            error(((("Failed to unregister a hotkey since there is no existing hotkey defined for key: Keyboard." .. tostring(Keyboard[keyboardOrFunc])) .. " (") .. tostring(keyboardOrFunc)) .. ")")
+        end
+        staticHotkeyFunctionMap:delete(keyboardOrFunc)
     end
-    hotkeyFunctionMap:delete(keyboard)
 end
 return ____exports

package/index.d.ts

@@ -13,6 +13,7 @@ export { ConversionHeartSubType, registerCharacterHealthConversion, } from "./fe
 export { registerCharacterStats } from "./features/characterStats";
 export { getCollectibleItemPoolType } from "./features/collectibleItemPoolType";
 export { removeCustomGrid, spawnCustomGrid } from "./features/customGridEntity";
+export * from "./features/customStage/exports";
 export * from "./features/debugDisplay/exports";
 export { deployJSONRoom, deployRandomJSONRoom, emptyRoom, } from "./features/deployJSONRoom";
 export { disableAllSound, enableAllSound } from "./features/disableAllSound";

package/index.lua

@@ -107,6 +107,14 @@ do
     ____exports.removeCustomGrid = removeCustomGrid
     ____exports.spawnCustomGrid = spawnCustomGrid
 end
+do
+    local ____export = require("features.customStage.exports")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("features.debugDisplay.exports")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "5.1.3",
+  "version": "6.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",