Class: PauseControl

PauseControl()

Controller to pause or resume the game and remember which players paused the game. If the current player ordered a pause manually, it is called explicit pause. If the player opened a dialog in single-player mode, the game is paused implicitly.

Constructor

new PauseControl()

Source:

Members

explicitPause

This is true if the current player has paused the game using the pause button or hotkey. The game may also be paused without this being true in single-player mode when opening a dialog.
Source:

pauseHandlers

Event handlers called when anyone paused.
Source:

pausingClients

List of GUIDs of players who have currently paused the game, if the game is networked.
Source:

Methods

canPause()

Returns true if the current player is allowed to pause the game currently.
Source:

implicitPause()

Called from UI dialogs, but only in single-player mode.
Source:

setClientPauseState()

Called when a client pauses or resumes in a multiplayer game.
Source: