isaacscript-common 12.6.1 → 13.1.0

package/src/objects/roomShapeCorners.ts

@@ -2,10 +2,12 @@ import { RoomShape } from "isaac-typescript-definitions";
 import { CornerType } from "../enums/CornerType";
 import { Corner } from "../interfaces/Corner";
 
-const TWO_BY_TWO_CENTER_X = 580;
-const TWO_BY_TWO_CENTER_Y = 420;
-
-/** The locations of the corners for each room shape. */
+/**
+ * The locations of the corners for each room shape.
+ *
+ * Note that these corner locations are not accurate for the Mother Boss Room and the Home closet
+ * rooms. (Those rooms have custom shapes.)
+ */
 export const ROOM_SHAPE_CORNERS: {
   readonly [key in RoomShape]: readonly Corner[];
 } = {
@@ -13,18 +15,22 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.SHAPE_1x1]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 0,
       position: Vector(60, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 14,
       position: Vector(580, 140),
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 120,
       position: Vector(60, 420),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 134,
       position: Vector(580, 420),
     },
   ],
@@ -33,18 +39,22 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.IH]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 30,
       position: Vector(60, 220),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 44,
       position: Vector(580, 220),
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 90,
       position: Vector(60, 340),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 104,
       position: Vector(580, 340),
     },
   ],
@@ -53,18 +63,22 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.IV]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 4,
       position: Vector(220, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 10,
       position: Vector(420, 140),
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 124,
       position: Vector(220, 420),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 130,
       position: Vector(420, 420),
     },
   ],
@@ -73,18 +87,22 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.SHAPE_1x2]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 0,
       position: Vector(60, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 14,
       position: Vector(580, 140),
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 225,
       position: Vector(60, 700),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 239,
       position: Vector(580, 700),
     },
   ],
@@ -93,18 +111,22 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.IIV]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 4,
       position: Vector(220, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 10,
       position: Vector(420, 140),
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 229,
       position: Vector(220, 700),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 235,
       position: Vector(420, 700),
     },
   ],
@@ -113,18 +135,22 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.SHAPE_2x1]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 0,
       position: Vector(60, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 27,
       position: Vector(1100, 140),
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 224,
       position: Vector(60, 420),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 251,
       position: Vector(1100, 420),
     },
   ],
@@ -133,18 +159,22 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.IIH]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 56,
       position: Vector(60, 220),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 83,
       position: Vector(1100, 220),
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 168,
       position: Vector(60, 340),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 195,
       position: Vector(1100, 340),
     },
   ],
@@ -153,18 +183,22 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.SHAPE_2x2]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 0,
       position: Vector(60, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 27,
       position: Vector(1100, 140),
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 420,
       position: Vector(60, 700),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 447,
       position: Vector(1100, 700),
     },
   ],
@@ -173,26 +207,32 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.LTL]: [
     {
       type: CornerType.TOP_LEFT,
-      position: Vector(TWO_BY_TWO_CENTER_X, 140), // Center
+      gridIndex: 13,
+      position: Vector(580, 140), // Center
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 27,
       position: Vector(1100, 140),
     },
     {
       type: CornerType.TOP_LEFT,
-      position: Vector(60, TWO_BY_TWO_CENTER_Y), // Left
+      gridIndex: 196,
+      position: Vector(60, 420), // Left
     },
     {
       type: CornerType.BOTTOM_RIGHT,
-      position: Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y), // Center
+      gridIndex: 209,
+      position: Vector(580, 420), // Center
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 420,
       position: Vector(60, 700),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 447,
       position: Vector(1100, 700),
     },
   ],
@@ -201,26 +241,32 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.LTR]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 0,
       position: Vector(60, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
-      position: Vector(TWO_BY_TWO_CENTER_X, 140), // Center
+      gridIndex: 14,
+      position: Vector(580, 140), // Center
     },
     {
       type: CornerType.BOTTOM_LEFT,
-      position: Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y), // Center
+      gridIndex: 210,
+      position: Vector(580, 420), // Center
     },
     {
       type: CornerType.TOP_RIGHT,
-      position: Vector(1100, TWO_BY_TWO_CENTER_Y), // Right
+      gridIndex: 223,
+      position: Vector(1100, 420), // Right
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 420,
       position: Vector(60, 700),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 447,
       position: Vector(1100, 700),
     },
   ],
@@ -229,26 +275,32 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.LBL]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 0,
       position: Vector(60, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 27,
       position: Vector(1100, 140),
     },
     {
       type: CornerType.BOTTOM_LEFT,
-      position: Vector(TWO_BY_TWO_CENTER_X, 140), // Left
+      gridIndex: 224,
+      position: Vector(580, 140), // Left
     },
     {
       type: CornerType.TOP_RIGHT,
-      position: Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y), // Center
+      gridIndex: 237,
+      position: Vector(580, 420), // Center
     },
     {
       type: CornerType.BOTTOM_LEFT,
-      position: Vector(TWO_BY_TWO_CENTER_X, 700), // Center
+      gridIndex: 433,
+      position: Vector(580, 700), // Center
     },
     {
       type: CornerType.BOTTOM_RIGHT,
+      gridIndex: 447,
       position: Vector(1100, 700),
     },
   ],
@@ -257,27 +309,33 @@ export const ROOM_SHAPE_CORNERS: {
   [RoomShape.LBR]: [
     {
       type: CornerType.TOP_LEFT,
+      gridIndex: 0,
       position: Vector(60, 140),
     },
     {
       type: CornerType.TOP_RIGHT,
+      gridIndex: 27,
       position: Vector(1100, 140),
     },
     {
       type: CornerType.TOP_LEFT,
-      position: Vector(TWO_BY_TWO_CENTER_X, TWO_BY_TWO_CENTER_Y), // Center
+      gridIndex: 238,
+      position: Vector(580, 420), // Center
     },
     {
       type: CornerType.BOTTOM_RIGHT,
-      position: Vector(1100, TWO_BY_TWO_CENTER_Y), // Right
+      gridIndex: 251,
+      position: Vector(1100, 420), // Right
     },
     {
       type: CornerType.BOTTOM_LEFT,
+      gridIndex: 420,
       position: Vector(60, 700),
     },
     {
       type: CornerType.BOTTOM_RIGHT,
-      position: Vector(TWO_BY_TWO_CENTER_X, 700), // Right
+      gridIndex: 434,
+      position: Vector(580, 700), // Right
     },
   ],
 } as const;

package/dist/src/features/registerHotkey.d.ts

@@ -1,23 +0,0 @@
-import { Keyboard } from "isaac-typescript-definitions";
-/**
- * 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;
-//# sourceMappingURL=registerHotkey.d.ts.map

package/dist/src/features/registerHotkey.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"registerHotkey.d.ts","sourceRoot":"","sources":["../../../src/features/registerHotkey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAe,MAAM,8BAA8B,CAAC;AAyDrE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,cAAc,EAAE,QAAQ,GAAG,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAC,EACvD,WAAW,EAAE,MAAM,IAAI,GACtB,IAAI,CAoBN;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,cAAc,EAAE,QAAQ,GAAG,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAC,GACtD,IAAI,CAoBN"}

package/dist/src/features/registerHotkey.lua

@@ -1,93 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__New = ____lualib.__TS__New
-local __TS__Iterator = ____lualib.__TS__Iterator
-local ____exports = {}
-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
-local ____DefaultMap = require("src.classes.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
-local ____featuresInitialized = require("src.featuresInitialized")
-local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
-local ____input = require("src.functions.input")
-local isKeyboardPressed = ____input.isKeyboardPressed
-local ____types = require("src.functions.types")
-local isFunction = ____types.isFunction
-function postRender(self)
-    for ____, ____value in __TS__Iterator(staticHotkeyFunctionMap:entries()) do
-        local keyboard = ____value[1]
-        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"
-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
---- 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 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
-end
---- 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 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
-end
-return ____exports

package/src/features/registerHotkey.ts

@@ -1,124 +0,0 @@
-import { Keyboard, ModCallback } from "isaac-typescript-definitions";
-import { DefaultMap } from "../classes/DefaultMap";
-import { errorIfFeaturesNotInitialized } from "../featuresInitialized";
-import { isKeyboardPressed } from "../functions/input";
-import { isFunction } from "../functions/types";
-
-const FEATURE_NAME = "registerHotkeys";
-
-/**
- * The keys are the keyboard keys that trigger the hotkey. The values are the functions that contain
- * the arbitrary code to run.
- */
-const staticHotkeyFunctionMap = new Map<Keyboard, () => void>();
-
-/**
- * The keys are the functions that determine what the hotkey key is. The values are the functions
- * that contain the arbitrary code to run.
- */
-const dynamicHotkeyFunctionMap = new Map<
-  () => Keyboard | undefined,
-  () => void
->();
-
-const keyPressedMap = new DefaultMap<Keyboard, boolean>(false);
-
-/** @internal */
-export function registerHotkeyInit(mod: Mod): void {
-  mod.AddCallback(ModCallback.POST_RENDER, postRender); // 2
-}
-
-// ModCallback.POST_RENDER (2)
-function postRender() {
-  for (const [keyboard, triggerFunc] of staticHotkeyFunctionMap.entries()) {
-    checkIfTriggered(keyboard, triggerFunc);
-  }
-
-  for (const [
-    keyboardFunc,
-    triggerFunc,
-  ] of dynamicHotkeyFunctionMap.entries()) {
-    const keyboard = keyboardFunc();
-    if (keyboard !== undefined) {
-      checkIfTriggered(keyboard, triggerFunc);
-    }
-  }
-}
-
-function checkIfTriggered(keyboard: Keyboard, triggerFunc: () => void) {
-  const isPressed = isKeyboardPressed(keyboard);
-  const wasPreviouslyPressed = keyPressedMap.getAndSetDefault(keyboard);
-  keyPressedMap.set(keyboard, isPressed);
-
-  if (isPressed && !wasPreviouslyPressed) {
-    triggerFunc();
-  }
-}
-
-/**
- * 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 function registerHotkey(
-  keyboardOrFunc: Keyboard | (() => Keyboard | undefined),
-  triggerFunc: () => void,
-): void {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-
-  if (isFunction(keyboardOrFunc)) {
-    if (dynamicHotkeyFunctionMap.has(keyboardOrFunc)) {
-      error(
-        "Failed to register a hotkey due to a custom hotkey already being defined for the submitted function.",
-      );
-    }
-
-    dynamicHotkeyFunctionMap.set(keyboardOrFunc, triggerFunc);
-  } else {
-    if (staticHotkeyFunctionMap.has(keyboardOrFunc)) {
-      error(
-        `Failed to register a hotkey due to a hotkey already being defined for key: Keyboard.${Keyboard[keyboardOrFunc]} (${keyboardOrFunc})`,
-      );
-    }
-
-    staticHotkeyFunctionMap.set(keyboardOrFunc, triggerFunc);
-  }
-}
-
-/**
- * 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 function unregisterHotkey(
-  keyboardOrFunc: Keyboard | (() => Keyboard | undefined),
-): void {
-  errorIfFeaturesNotInitialized(FEATURE_NAME);
-
-  if (isFunction(keyboardOrFunc)) {
-    if (!dynamicHotkeyFunctionMap.has(keyboardOrFunc)) {
-      error(
-        "Failed to unregister a hotkey since there is no existing hotkey defined for the submitted function.",
-      );
-    }
-
-    dynamicHotkeyFunctionMap.delete(keyboardOrFunc);
-  } else {
-    if (!staticHotkeyFunctionMap.has(keyboardOrFunc)) {
-      error(
-        `Failed to unregister a hotkey since there is no existing hotkey defined for key: Keyboard.${Keyboard[keyboardOrFunc]} (${keyboardOrFunc})`,
-      );
-    }
-
-    staticHotkeyFunctionMap.delete(keyboardOrFunc);
-  }
-}