Frames
Functions
Section titled “Functions”getElapsedGameFramesSince()
Section titled “getElapsedGameFramesSince()”getElapsedGameFramesSince(
gameFrameCount):int
Defined in: packages/isaacscript-common/src/functions/frames.ts:3
Parameters
Section titled “Parameters”gameFrameCount
Section titled “gameFrameCount”int
Returns
Section titled “Returns”int
getElapsedRenderFramesSince()
Section titled “getElapsedRenderFramesSince()”getElapsedRenderFramesSince(
renderFrameCount):int
Defined in: packages/isaacscript-common/src/functions/frames.ts:8
Parameters
Section titled “Parameters”renderFrameCount
Section titled “renderFrameCount”int
Returns
Section titled “Returns”int
getElapsedRoomFramesSince()
Section titled “getElapsedRoomFramesSince()”getElapsedRoomFramesSince(
roomFrameCount):int
Defined in: packages/isaacscript-common/src/functions/frames.ts:13
Parameters
Section titled “Parameters”roomFrameCount
Section titled “roomFrameCount”int
Returns
Section titled “Returns”int
isAfterGameFrame()
Section titled “isAfterGameFrame()”isAfterGameFrame(
gameFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:23
Helper function to check if the current game frame count is higher than a specific game frame count.
Parameters
Section titled “Parameters”gameFrameCount
Section titled “gameFrameCount”int
Returns
Section titled “Returns”boolean
isAfterRenderFrame()
Section titled “isAfterRenderFrame()”isAfterRenderFrame(
renderFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:32
Helper function to check if the current render frame count is higher than a specific render frame count.
Parameters
Section titled “Parameters”renderFrameCount
Section titled “renderFrameCount”int
Returns
Section titled “Returns”boolean
isAfterRoomFrame()
Section titled “isAfterRoomFrame()”isAfterRoomFrame(
roomFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:41
Helper function to check if the current room frame count is higher than a specific room frame count.
Parameters
Section titled “Parameters”roomFrameCount
Section titled “roomFrameCount”int
Returns
Section titled “Returns”boolean
isBeforeGameFrame()
Section titled “isBeforeGameFrame()”isBeforeGameFrame(
gameFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:52
Helper function to check if the current game frame count is lower than a specific game frame count.
Parameters
Section titled “Parameters”gameFrameCount
Section titled “gameFrameCount”int
Returns
Section titled “Returns”boolean
isBeforeRenderFrame()
Section titled “isBeforeRenderFrame()”isBeforeRenderFrame(
renderFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:61
Helper function to check if the current render frame count is lower than a specific render frame count.
Parameters
Section titled “Parameters”renderFrameCount
Section titled “renderFrameCount”int
Returns
Section titled “Returns”boolean
isBeforeRoomFrame()
Section titled “isBeforeRoomFrame()”isBeforeRoomFrame(
roomFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:70
Helper function to check if the current room frame count is lower than a specific room frame count.
Parameters
Section titled “Parameters”roomFrameCount
Section titled “roomFrameCount”int
Returns
Section titled “Returns”boolean
onGameFrame()
Section titled “onGameFrame()”onGameFrame(
gameFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:83
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 render frame count is null or undefined.
Parameters
Section titled “Parameters”gameFrameCount
Section titled “gameFrameCount”int | null | undefined
Returns
Section titled “Returns”boolean
onOrAfterGameFrame()
Section titled “onOrAfterGameFrame()”onOrAfterGameFrame(
gameFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:92
Helper function to check if the current game frame count is equal to or higher than a specific game frame count.
Parameters
Section titled “Parameters”gameFrameCount
Section titled “gameFrameCount”int
Returns
Section titled “Returns”boolean
onOrAfterRenderFrame()
Section titled “onOrAfterRenderFrame()”onOrAfterRenderFrame(
renderFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:101
Helper function to check if the current render frame count is equal to or higher than a specific render frame count.
Parameters
Section titled “Parameters”renderFrameCount
Section titled “renderFrameCount”int
Returns
Section titled “Returns”boolean
onOrAfterRoomFrame()
Section titled “onOrAfterRoomFrame()”onOrAfterRoomFrame(
roomFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:110
Helper function to check if the current room frame count is equal to or higher than a specific room frame count.
Parameters
Section titled “Parameters”roomFrameCount
Section titled “roomFrameCount”int
Returns
Section titled “Returns”boolean
onOrBeforeGameFrame()
Section titled “onOrBeforeGameFrame()”onOrBeforeGameFrame(
gameFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:121
Helper function to check if the current game frame count is equal to or lower than a specific game frame count.
Parameters
Section titled “Parameters”gameFrameCount
Section titled “gameFrameCount”int
Returns
Section titled “Returns”boolean
onOrBeforeRenderFrame()
Section titled “onOrBeforeRenderFrame()”onOrBeforeRenderFrame(
renderFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:130
Helper function to check if the current render frame count is equal to or lower than a specific render frame count.
Parameters
Section titled “Parameters”renderFrameCount
Section titled “renderFrameCount”int
Returns
Section titled “Returns”boolean
onOrBeforeRoomFrame()
Section titled “onOrBeforeRoomFrame()”onOrBeforeRoomFrame(
roomFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:139
Helper function to check if the current room frame count is equal to or lower than a specific room frame count.
Parameters
Section titled “Parameters”roomFrameCount
Section titled “roomFrameCount”int
Returns
Section titled “Returns”boolean
onRenderFrame()
Section titled “onRenderFrame()”onRenderFrame(
renderFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:152
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.
Parameters
Section titled “Parameters”renderFrameCount
Section titled “renderFrameCount”int | null | undefined
Returns
Section titled “Returns”boolean
onRoomFrame()
Section titled “onRoomFrame()”onRoomFrame(
roomFrameCount):boolean
Defined in: packages/isaacscript-common/src/functions/frames.ts:165
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.
Parameters
Section titled “Parameters”roomFrameCount
Section titled “roomFrameCount”int | null | undefined
Returns
Section titled “Returns”boolean