Function CmdPause

src/misc_cmd.cpp:167–213

* Pause/Unpause the game (server-only). * Set or unset a bit in the pause mode. If pause mode is zero the game is * unpaused. A bitset is used instead of a boolean value/counter to have * more control over the game when saving/loading, etc. * @param flags operation to perform * @param mode the pause mode to change * @param pause true pauses, false unpauses this mode * @return the cost of th

 * @return the cost of this operation or an error
 */
CommandCost CmdPause(DoCommandFlags flags, PauseMode mode, bool pause)
{
	switch (mode) {
		case PauseMode::SaveLoad:
		case PauseMode::Error:
		case PauseMode::Normal:
		case PauseMode::GameScript:
		case PauseMode::LinkGraph:
			break;

		case PauseMode::Join:
		case PauseMode::ActiveClients:
			if (!_networking) return CMD_ERROR;
			break;

		default: return CMD_ERROR;
	}
	if (flags.Test(DoCommandFlag::Execute)) {
		if (mode == PauseMode::Normal && _pause_mode.Test(PauseMode::Error)) {
			ShowQuery(
				GetEncodedString(STR_NEWGRF_UNPAUSE_WARNING_TITLE),
				GetEncodedString(STR_NEWGRF_UNPAUSE_WARNING),
				nullptr,
				AskUnsafeUnpauseCallback
			);
		} else {
			PauseModes prev_mode = _pause_mode;

			if (pause) {
				_pause_mode.Set(mode);
			} else {
				_pause_mode.Reset(mode);

				/* If the only remaining reason to be paused is that we saw a command during pause, unpause. */
				if (_pause_mode == PauseMode::CommandDuringPause) {
					_pause_mode = {};
				}
			}

			NetworkHandlePauseChange(prev_mode, mode);
		}

		SetWindowDirty(WC_STATUS_BAR, 0);
		SetWindowDirty(WC_MAIN_TOOLBAR, 0);
	}
	return CommandCost();
}

/**
 * Change the financial flow of your company.