isaacscript-common 5.1.4 → 6.0.1

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

@@ -13,10 +13,10 @@ import { Keyboard } from "isaac-typescript-definitions";
  * @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), triggerFunc: () => void): void;
+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)): void;
+export declare function unregisterHotkey(keyboardOrFunc: Keyboard | (() => Keyboard | undefined)): void;

package/features/registerHotkey.lua

@@ -25,7 +25,9 @@ function postRender(self)
         local keyboardFunc = ____value[1]
         local triggerFunc = ____value[2]
         local keyboard = keyboardFunc(nil)
-        checkIfTriggered(nil, keyboard, triggerFunc)
+        if keyboard ~= nil then
+            checkIfTriggered(nil, keyboard, triggerFunc)
+        end
     end
 end
 function checkIfTriggered(self, keyboard, triggerFunc)

package/functions/doors.d.ts

@@ -24,13 +24,13 @@ export declare function getDevilRoomOrAngelRoomDoor(): GridEntityDoor | undefine
  */
 export declare function getDoorEnterPosition(door: GridEntityDoor): Vector;
 /**
- * Helper function to help calculate the position that a player will enter a room at.
+ * Helper function to get the offset from a door position that a player will enter a room at.
  *
  * When players enter a room, they do not appear exactly on the location of the door, because then
  * they would immediately collide with the loading zone. Instead, they are offset by a certain
  * amount of units.
  */
-export declare function getDoorEnterPositionOffset(doorSlot: DoorSlot): Vector;
+export declare function getDoorSlotEnterPositionOffset(doorSlot: DoorSlot): Vector;
 /**
  * Helper function to convert an array of door slots or a set of door slots to the resulting bit
  * flag number.

package/functions/doors.lua

@@ -39,15 +39,16 @@ local isTSTLSet = ____tstlClass.isTSTLSet
 function ____exports.doorSlotToDirection(self, doorSlot)
     return DOOR_SLOT_TO_DIRECTION[doorSlot]
 end
---- Helper function to help calculate the position that a player will enter a room at.
+--- Helper function to get the offset from a door position that a player will enter a room at.
 -- 
 -- When players enter a room, they do not appear exactly on the location of the door, because then
 -- they would immediately collide with the loading zone. Instead, they are offset by a certain
 -- amount of units.
-function ____exports.getDoorEnterPositionOffset(self, doorSlot)
+function ____exports.getDoorSlotEnterPositionOffset(self, doorSlot)
     local direction = ____exports.doorSlotToDirection(nil, doorSlot)
     local vector = directionToVector(nil, direction)
-    return vector * ROOM_ENTRY_OFFSET_FROM_DOOR
+    local oppositeVector = vector * -1
+    return oppositeVector * ROOM_ENTRY_OFFSET_FROM_DOOR
 end
 --- Helper function to get all of the doors in the room. By default, it will return every door. You
 -- can optionally specify one or more room types to return only the doors that match the specified
@@ -152,7 +153,7 @@ end
 -- they would immediately collide with the loading zone. Instead, they are offset by a certain
 -- amount of units.
 function ____exports.getDoorEnterPosition(self, door)
-    local offset = ____exports.getDoorEnterPositionOffset(nil, door.Slot)
+    local offset = ____exports.getDoorSlotEnterPositionOffset(nil, door.Slot)
     return door.Position + offset
 end
 --- Helper function to convert an array of door slots or a set of door slots to the resulting bit

package/package.json

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