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