isaacscript-common 59.4.1 → 59.6.0

package/src/functions/frames.ts

@@ -0,0 +1,172 @@
+import { game } from "../core/cachedClasses";
+
+export function getElapsedGameFramesSince(gameFrameCount: int): int {
+  const thisGameFrameCount = game.GetFrameCount();
+  return thisGameFrameCount - gameFrameCount;
+}
+
+export function getElapsedRenderFramesSince(renderFrameCount: int): int {
+  const thisRenderFrameCount = Isaac.GetFrameCount();
+  return thisRenderFrameCount - renderFrameCount;
+}
+
+export function getElapsedRoomFramesSince(roomFrameCount: int): int {
+  const room = game.GetRoom();
+  const thisRoomFrameCount = room.GetFrameCount();
+  return thisRoomFrameCount - roomFrameCount;
+}
+
+/**
+ * Helper function to check if the current game frame count is higher than a specific game frame
+ * count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export function isPastGameFrame(
+  gameFrameCount: int | null | undefined,
+): boolean {
+  if (gameFrameCount === null || gameFrameCount === undefined) {
+    return false;
+  }
+
+  const thisGameFrameCount = game.GetFrameCount();
+  return thisGameFrameCount > gameFrameCount;
+}
+
+/**
+ * Helper function to check if the current render frame count is higher than a specific render frame
+ * count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export function isPastRenderFrame(
+  renderFrameCount: int | null | undefined,
+): boolean {
+  if (renderFrameCount === null || renderFrameCount === undefined) {
+    return false;
+  }
+
+  const thisRenderFrameCount = Isaac.GetFrameCount();
+  return thisRenderFrameCount >= renderFrameCount;
+}
+
+/**
+ * Helper function to check if the current room frame count is higher than a specific room frame
+ * count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export function isPastRoomFrame(
+  roomFrameCount: int | null | undefined,
+): boolean {
+  if (roomFrameCount === null || roomFrameCount === undefined) {
+    return false;
+  }
+
+  const room = game.GetRoom();
+
+  const thisGameFrameCount = room.GetFrameCount();
+  return thisGameFrameCount > roomFrameCount;
+}
+
+/**
+ * Helper function to check if the current game frame count is exactly equal to a specific game
+ * frame count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export function onGameFrame(gameFrameCount: int | null | undefined): boolean {
+  if (gameFrameCount === null || gameFrameCount === undefined) {
+    return false;
+  }
+
+  const thisGameFrameCount = game.GetFrameCount();
+  return thisGameFrameCount === gameFrameCount;
+}
+
+/**
+ * Helper function to check if the current game frame count is equal to or higher than a specific
+ * game frame count.
+ *
+ * This returns false if the submitted game frame count is null or undefined.
+ */
+export function onOrPastGameFrame(
+  gameFrameCount: int | null | undefined,
+): boolean {
+  if (gameFrameCount === null || gameFrameCount === undefined) {
+    return false;
+  }
+
+  const thisGameFrameCount = game.GetFrameCount();
+  return thisGameFrameCount >= gameFrameCount;
+}
+
+/**
+ * Helper function to check if the current render frame count is equal to or higher than a specific
+ * render frame count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export function onOrPastRenderFrame(
+  renderFrameCount: int | null | undefined,
+): boolean {
+  if (renderFrameCount === null || renderFrameCount === undefined) {
+    return false;
+  }
+
+  const thisRenderFrameCount = Isaac.GetFrameCount();
+  return thisRenderFrameCount >= renderFrameCount;
+}
+
+/**
+ * Helper function to check if the current room frame count is equal to or higher than a specific
+ * room frame count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export function onOrPastRoomFrame(
+  roomFrameCount: int | null | undefined,
+): boolean {
+  if (roomFrameCount === null || roomFrameCount === undefined) {
+    return false;
+  }
+
+  const room = game.GetRoom();
+
+  const thisGameFrameCount = room.GetFrameCount();
+  return thisGameFrameCount >= roomFrameCount;
+}
+
+/**
+ * Helper function to check if the current render frame count is exactly equal to a specific render
+ * frame count.
+ *
+ * This returns false if the submitted render frame count is null or undefined.
+ */
+export function onRenderFrame(
+  renderFrameCount: int | null | undefined,
+): boolean {
+  if (renderFrameCount === null || renderFrameCount === undefined) {
+    return false;
+  }
+
+  const thisRenderFrameCount = Isaac.GetFrameCount();
+  return thisRenderFrameCount >= renderFrameCount;
+}
+
+/**
+ * Helper function to check if the current room frame count is exactly equal to a specific room
+ * frame count.
+ *
+ * This returns false if the submitted room frame count is null or undefined.
+ */
+export function onRoomFrame(roomFrameCount: int | null | undefined): boolean {
+  if (roomFrameCount === null || roomFrameCount === undefined) {
+    return false;
+  }
+
+  const room = game.GetRoom();
+
+  const thisGameFrameCount = room.GetFrameCount();
+  return thisGameFrameCount === roomFrameCount;
+}

package/src/functions/gridEntities.ts

@@ -690,21 +690,9 @@ export function getSurroundingGridEntities(
   gridEntity: GridEntity,
 ): GridEntity[] {
   const room = game.GetRoom();
-  const gridWidth = room.GetGridWidth();
   const gridIndex = gridEntity.GetGridIndex();
 
-  const surroundingGridIndexes: int[] = [
-    gridIndex - 1, // Left
-    gridIndex + 1, // Right
-
-    gridIndex - gridWidth - 1, // Top-left
-    gridIndex - gridWidth, // Top
-    gridIndex - gridWidth + 1, // Top-right
-
-    gridIndex + gridWidth - 1, // Bottom-left
-    gridIndex + gridWidth, // Bottom
-    gridIndex + gridWidth + 1, // Bottom-right
-  ];
+  const surroundingGridIndexes = getSurroundingGridIndexes(gridIndex);
 
   const surroundingGridEntities: GridEntity[] = [];
   for (const surroundingGridIndex of surroundingGridIndexes) {
@@ -717,6 +705,42 @@ export function getSurroundingGridEntities(
   return surroundingGridEntities;
 }
 
+/**
+ * Helper function to get the grid indexes on the surrounding tiles from the provided grid index.
+ *
+ * There are always 8 grid indexes returned (e.g. top-left + top + top-right + left + right +
+ * bottom-left + bottom + right), even if the computed values would be negative or otherwise
+ * invalid.
+ */
+export function getSurroundingGridIndexes(
+  gridIndex: int,
+): [
+  topLeft: int,
+  top: int,
+  topRight: int,
+  left: int,
+  right: int,
+  bottomLeft: int,
+  bottom: int,
+  bottomRight: int,
+] {
+  const room = game.GetRoom();
+  const gridWidth = room.GetGridWidth();
+
+  return [
+    gridIndex - gridWidth - 1, // Top-left
+    gridIndex - gridWidth, // Top
+    gridIndex - gridWidth + 1, // Top-right
+
+    gridIndex - 1, // Left
+    gridIndex + 1, // Right
+
+    gridIndex + gridWidth - 1, // Bottom-left
+    gridIndex + gridWidth, // Bottom
+    gridIndex + gridWidth + 1, // Bottom-right
+  ];
+}
+
 /**
  * Helper function to get the top left wall in the current room.
  *
@@ -785,6 +809,28 @@ export function isGridEntityXMLType(num: number): num is GridEntityXMLType {
   return GRID_ENTITY_XML_TYPES_SET.has(num); // eslint-disable-line isaacscript/strict-enums
 }
 
+/**
+ * Helper function to check if the provided grid index has a door on it or if the surrounding 8 grid
+ * indexes have a door on it.
+ */
+export function isGridIndexAdjacentToDoor(gridIndex: int): boolean {
+  const room = game.GetRoom();
+  const surroundingGridIndexes = getSurroundingGridIndexes(gridIndex);
+  const gridIndexes = [gridIndex, ...surroundingGridIndexes];
+
+  for (const gridIndexToInspect of gridIndexes) {
+    const gridEntity = room.GetGridEntity(gridIndexToInspect);
+    if (gridEntity !== undefined) {
+      const door = gridEntity.ToDoor();
+      if (door !== undefined) {
+        return true;
+      }
+    }
+  }
+
+  return false;
+}
+
 /** Helper function to see if a `GridEntityXMLType` is some kind of poop. */
 export function isPoopGridEntityXMLType(
   gridEntityXMLType: GridEntityXMLType,

package/src/functions/revive.ts

@@ -5,13 +5,13 @@ import {
   PlayerType,
   TrinketType,
 } from "isaac-typescript-definitions";
-import { game } from "../core/cachedClasses";
 import {
   MAX_TAINTED_SAMSON_BERSERK_CHARGE,
   TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE,
 } from "../core/constants";
 import { MysteriousPaperEffect } from "../enums/MysteriousPaperEffect";
 import { getCharacterDeathAnimationName } from "./characters";
+import { onGameFrame } from "./frames";
 import { getPlayerMaxHeartContainers } from "./playerHealth";
 import { getPlayerNumHitsRemaining, hasLostCurse, isKeeper } from "./players";
 import { getLastFrameOfAnimation } from "./sprites";
@@ -28,7 +28,6 @@ export function isDamageToPlayerFatal(
   source: EntityRef,
   lastDamageGameFrame: int | undefined,
 ): boolean {
-  const gameFrameCount = game.GetFrameCount();
   const character = player.GetPlayerType();
   const effects = player.GetEffects();
   const isBerserk = effects.HasCollectibleEffect(CollectibleType.BERSERK);
@@ -91,7 +90,7 @@ export function isDamageToPlayerFatal(
   // damage on the same frame.
   if (
     player.HasCollectible(CollectibleType.BROKEN_GLASS_CANNON) &&
-    gameFrameCount === lastDamageGameFrame
+    onGameFrame(lastDamageGameFrame)
   ) {
     return false;
   }

package/src/index.ts

@@ -54,6 +54,7 @@ export * from "./functions/enums";
 export * from "./functions/external";
 export * from "./functions/familiars";
 export * from "./functions/flag";
+export * from "./functions/frames";
 export * from "./functions/globals";
 export * from "./functions/gridEntities";
 export * from "./functions/gridEntitiesSpecific";