Skip to main content

Pause

Hierarchy​

  • Feature

    ↳ Pause

Methods​

isPaused​

▸ isPaused(): boolean

Helper function to check if the pause feature from isaacscript-common is currently pseudo-pausing the game.

Returns​

boolean

Defined in​

packages/isaacscript-common/src/classes/features/other/Pause.ts:131

pause​

▸ pause(): void

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_CONFIRM and ButtonAction.CONSOLE)

In order to use this function, you must upgrade your mod with ISCFeature.PAUSE.

Returns​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/Pause.ts:149

unpause​

▸ unpause(): void

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​

void

Defined in​

packages/isaacscript-common/src/classes/features/other/Pause.ts:214