isaacscript-common 59.4.1 → 59.6.0

package/dist/index.rollup.d.ts

@@ -5487,6 +5487,19 @@ export declare function getEffects(effectVariant?: EffectVariant | -1, subType?:
  */
 export declare function getEffectsList(player: EntityPlayer): TemporaryEffect[];
 
+export declare function getElapsedGameFramesSince(gameFrameCount: int): int;
+
+export declare function getElapsedRenderFramesSince(renderFrameCount: int): int;
+
+export declare function getElapsedRoomFramesSince(roomFrameCount: int): int;
+
+/**
+ * Helper function to get the amount of elapsed time for benchmarking / profiling purposes.
+ *
+ * For more information, see the documentation for the `getTime` helper function.
+ */
+export declare function getElapsedTimeSince(time: int | float): int;
+
 /**
  * Helper function to get all of the entities in the room or all of the entities that match a
  * specific entity type / variant / sub-type.
@@ -7629,6 +7642,24 @@ export declare function getSubPlayerParent(subPlayer: EntitySubPlayer): EntityPl
  */
 export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 
+/**
+ * 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 declare function getSurroundingGridIndexes(gridIndex: int): [
+topLeft: int,
+top: int,
+topRight: int,
+left: int,
+right: int,
+bottomLeft: int,
+bottom: int,
+bottomRight: int
+];
+
 /**
  * Helper function to determine how many heart containers that Tainted Magdalene has that will not
  * be automatically depleted over time. By default, this is 2, but this function will return 4 so
@@ -7695,7 +7726,7 @@ export declare function getTeleporters(variant?: number): GridEntity[];
  *                             Default is true. If set to false, the `Isaac.GetTime()` method will
  *                             always be used.
  */
-export declare function getTime(useSocketIfAvailable?: boolean): float;
+export declare function getTime(useSocketIfAvailable?: boolean): int | float;
 
 /** Helper function to get all of the `GridEntityTNT` in the room. */
 export declare function getTNT(variant?: number): GridEntityTNT[];
@@ -9185,6 +9216,12 @@ export declare function isGridEntityBroken(gridEntity: GridEntity): boolean;
  */
 export declare function isGridEntityXMLType(num: number): num is GridEntityXMLType;
 
+/**
+ * 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 declare function isGridIndexAdjacentToDoor(gridIndex: int): boolean;
+
 /** For `PickupVariant.HEART` (10). */
 export declare function isHeart(pickup: EntityPickup): pickup is EntityPickupHeart;
 
@@ -9376,6 +9413,30 @@ export declare function isOdd(num: int): boolean;
  */
 export declare function isPassiveOrFamiliarCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
 
+/**
+ * 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 declare function isPastGameFrame(gameFrameCount: int | null | undefined): boolean;
+
+/**
+ * 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 declare function isPastRenderFrame(renderFrameCount: int | null | undefined): boolean;
+
+/**
+ * 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 declare function isPastRoomFrame(roomFrameCount: int | null | undefined): boolean;
+
 /** Helper function to narrow the type of `PickingUpItem`. */
 export declare function isPickingUpItemCollectible(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemCollectible;
 
@@ -14387,12 +14448,60 @@ export declare function onFinalFloor(): boolean;
  */
 export declare function onFirstFloor(): boolean;
 
+/**
+ * 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 declare function onGameFrame(gameFrameCount: int | null | undefined): boolean;
+
+/**
+ * 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 declare function onOrPastGameFrame(gameFrameCount: int | null | undefined): boolean;
+
+/**
+ * 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 declare function onOrPastRenderFrame(renderFrameCount: int | null | undefined): boolean;
+
+/**
+ * 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 declare function onOrPastRoomFrame(roomFrameCount: int | null | undefined): boolean;
+
+/**
+ * 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 declare function onRenderFrame(renderFrameCount: int | null | undefined): boolean;
+
 /**
  * Helper function to check if the current stage type is equal to `StageType.REPENTANCE` or
  * `StageType.REPENTANCE_B`.
  */
 export declare function onRepentanceStage(): boolean;
 
+/**
+ * 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 declare function onRoomFrame(roomFrameCount: int | null | undefined): boolean;
+
 /**
  * Helper function to check whether the player is playing on a set seed (i.e. that they entered in a
  * specific seed by pressing tab on the character selection screen). When the player resets the game