Pause
Classes
Section titled “Classes”Defined in: packages/isaacscript-common/src/classes/features/other/Pause.ts:44
Extends
Section titled “Extends”Feature
Methods
Section titled “Methods”isPaused()
Section titled “isPaused()”isPaused():
boolean
Defined in: packages/isaacscript-common/src/classes/features/other/Pause.ts:137
Helper function to check if the pause feature from isaacscript-common is currently
pseudo-pausing the game.
Returns
Section titled “Returns”boolean
pause()
Section titled “pause()”pause():
void
Defined in: packages/isaacscript-common/src/classes/features/other/Pause.ts:155
Helper function to emulate what happens when the player pauses the game. Use the unpause
function to return things back to normal.
Under the hood, this function:
- uses the Pause collectible on every game frame
- disables any player inputs (except for
ButtonAction.MENU_CONFIRMandButtonAction.CONSOLE)
In order to use this function, you must upgrade your mod with ISCFeature.PAUSE.
Returns
Section titled “Returns”void
unpause()
Section titled “unpause()”unpause():
void
Defined in: packages/isaacscript-common/src/classes/features/other/Pause.ts:227
Helper function to put things back to normal after the pause function was used.
In order to use this function, you must upgrade your mod with ISCFeature.PAUSE.
Returns
Section titled “Returns”void