Add the ability to define starting life total during game creation. (#5174)

* Have the server respect gameType info when setting up zones.

* ServerPlayer::setupZones is now passed the room->getGameTypes();
* ServerPlayer::setupZones now checks if the GameType String includes "Commander" and then sets the life total to 40 instead.

* Formatting.

* Remove debug logging imports.

* Move game option value declarations to dlg_create_game.

* Lint.

* Fix mocks.

* Add a default for backwards compatibility.

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>

cockatrice/src/dialogs/dlg_create_game.cpp

@@ -95,12 +95,26 @@ void DlgCreateGame::sharedCtor()
     spectatorsGroupBox = new QGroupBox(tr("Spectators"));
     spectatorsGroupBox->setLayout(spectatorsLayout);
 
+    startingLifeTotalLabel = new QLabel(tr("Starting life total:"));
+    startingLifeTotalEdit = new QSpinBox();
+    startingLifeTotalEdit->setMinimum(1);
+    startingLifeTotalEdit->setMaximum(99999); ///< Arbitrary but we can raise this when people start complaining.
+    startingLifeTotalEdit->setValue(20);
+    startingLifeTotalLabel->setBuddy(startingLifeTotalEdit);
+
+    QGridLayout *gameSetupOptionsLayout = new QGridLayout;
+    gameSetupOptionsLayout->addWidget(startingLifeTotalLabel, 0, 0);
+    gameSetupOptionsLayout->addWidget(startingLifeTotalEdit, 0, 1);
+    gameSetupOptionsGroupBox = new QGroupBox(tr("Game setup options"));
+    gameSetupOptionsGroupBox->setLayout(gameSetupOptionsLayout);
+
     QGridLayout *grid = new QGridLayout;
     grid->addWidget(generalGroupBox, 0, 0);
     grid->addWidget(joinRestrictionsGroupBox, 0, 1);
     grid->addWidget(gameTypeGroupBox, 1, 0);
     grid->addWidget(spectatorsGroupBox, 1, 1, Qt::AlignTop);
-    grid->addWidget(rememberGameSettings, 2, 0);
+    grid->addWidget(gameSetupOptionsGroupBox, 2, 0);
+    grid->addWidget(rememberGameSettings, 3, 0);
 
     buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok);
     connect(buttonBox, SIGNAL(rejected()), this, SLOT(reject()));
@@ -134,6 +148,7 @@ DlgCreateGame::DlgCreateGame(TabRoom *_room, const QMap<int, QString> &_gameType
     spectatorsCanTalkCheckBox->setChecked(SettingsCache::instance().getSpectatorsCanTalk());
     spectatorsSeeEverythingCheckBox->setChecked(SettingsCache::instance().getSpectatorsCanSeeEverything());
     createGameAsSpectatorCheckBox->setChecked(SettingsCache::instance().getCreateGameAsSpectator());
+    startingLifeTotalEdit->setValue(SettingsCache::instance().getDefaultStartingLifeTotal());
 
     if (!rememberGameSettings->isChecked()) {
         actReset();
@@ -208,6 +223,8 @@ void DlgCreateGame::actReset()
     spectatorsSeeEverythingCheckBox->setChecked(false);
     createGameAsSpectatorCheckBox->setChecked(false);
 
+    startingLifeTotalEdit->setValue(20);
+
     QMapIterator<int, QRadioButton *> gameTypeCheckBoxIterator(gameTypeCheckBoxes);
     while (gameTypeCheckBoxIterator.hasNext()) {
         gameTypeCheckBoxIterator.next();
@@ -234,6 +251,7 @@ void DlgCreateGame::actOK()
     cmd.set_spectators_see_everything(spectatorsSeeEverythingCheckBox->isChecked());
     cmd.set_join_as_judge(QApplication::keyboardModifiers() & Qt::ShiftModifier);
     cmd.set_join_as_spectator(createGameAsSpectatorCheckBox->isChecked());
+    cmd.set_starting_life_total(startingLifeTotalEdit->value());
 
     QString _gameTypes = QString();
     QMapIterator<int, QRadioButton *> gameTypeCheckBoxIterator(gameTypeCheckBoxes);
@@ -256,6 +274,7 @@ void DlgCreateGame::actOK()
         SettingsCache::instance().setSpectatorsCanTalk(spectatorsCanTalkCheckBox->isChecked());
         SettingsCache::instance().setSpectatorsCanSeeEverything(spectatorsSeeEverythingCheckBox->isChecked());
         SettingsCache::instance().setCreateGameAsSpectator(createGameAsSpectatorCheckBox->isChecked());
+        SettingsCache::instance().setDefaultStartingLifeTotal(startingLifeTotalEdit->value());
         SettingsCache::instance().setGameTypes(_gameTypes);
     }
     PendingCommand *pend = room->prepareRoomCommand(cmd);

cockatrice/src/dialogs/dlg_create_game.h

@@ -35,10 +35,10 @@ private:
     QMap<int, QString> gameTypes;
     QMap<int, QRadioButton *> gameTypeCheckBoxes;
 
-    QGroupBox *generalGroupBox, *spectatorsGroupBox;
+    QGroupBox *generalGroupBox, *spectatorsGroupBox, *gameSetupOptionsGroupBox;
-    QLabel *descriptionLabel, *passwordLabel, *maxPlayersLabel;
+    QLabel *descriptionLabel, *passwordLabel, *maxPlayersLabel, *startingLifeTotalLabel;
     QLineEdit *descriptionEdit, *passwordEdit;
-    QSpinBox *maxPlayersEdit;
+    QSpinBox *maxPlayersEdit, *startingLifeTotalEdit;
     QCheckBox *onlyBuddiesCheckBox, *onlyRegisteredCheckBox;
     QCheckBox *spectatorsAllowedCheckBox, *spectatorsNeedPasswordCheckBox, *spectatorsCanTalkCheckBox,
         *spectatorsSeeEverythingCheckBox, *createGameAsSpectatorCheckBox;

cockatrice/src/settings/cache_settings.cpp

@@ -301,6 +301,7 @@ SettingsCache::SettingsCache()
     spectatorsCanTalk = settings->value("game/spectatorscantalk", false).toBool();
     spectatorsCanSeeEverything = settings->value("game/spectatorscanseeeverything", false).toBool();
     createGameAsSpectator = settings->value("game/creategameasspectator", false).toBool();
+    defaultStartingLifeTotal = settings->value("game/defaultstartinglifetotal", 20).toInt();
     rememberGameSettings = settings->value("game/remembergamesettings", true).toBool();
     clientID = settings->value("personal/clientid", CLIENT_INFO_NOT_SET).toString();
     clientVersion = settings->value("personal/clientversion", CLIENT_INFO_NOT_SET).toString();
@@ -1089,6 +1090,12 @@ void SettingsCache::setCreateGameAsSpectator(const bool _createGameAsSpectator)
     settings->setValue("game/creategameasspectator", createGameAsSpectator);
 }
 
+void SettingsCache::setDefaultStartingLifeTotal(const int _defaultStartingLifeTotal)
+{
+    defaultStartingLifeTotal = _defaultStartingLifeTotal;
+    settings->setValue("game/defaultstartinglifetotal", defaultStartingLifeTotal);
+};
+
 void SettingsCache::setRememberGameSettings(const bool _rememberGameSettings)
 {
     rememberGameSettings = _rememberGameSettings;

cockatrice/src/settings/cache_settings.h

@@ -163,6 +163,7 @@ private:
     bool spectatorsCanTalk;
     bool spectatorsCanSeeEverything;
     bool createGameAsSpectator;
+    int defaultStartingLifeTotal;
     int keepalive;
     int timeout;
     void translateLegacySettings();
@@ -515,6 +516,10 @@ public:
     {
         return spectatorsCanSeeEverything;
     }
+    int getDefaultStartingLifeTotal() const
+    {
+        return defaultStartingLifeTotal;
+    }
     bool getCreateGameAsSpectator() const
     {
         return createGameAsSpectator;
@@ -679,6 +684,7 @@ public slots:
     void setSpectatorsCanTalk(const bool _spectatorsCanTalk);
     void setSpectatorsCanSeeEverything(const bool _spectatorsCanSeeEverything);
     void setCreateGameAsSpectator(const bool _createGameAsSpectator);
+    void setDefaultStartingLifeTotal(const int _defaultStartingLifeTotal);
     void setRememberGameSettings(const bool _rememberGameSettings);
     void setNotifyAboutUpdate(QT_STATE_CHANGED_T _notifyaboutupdate);
     void setNotifyAboutNewVersion(QT_STATE_CHANGED_T _notifyaboutnewversion);

common/pb/room_commands.proto

@@ -38,6 +38,7 @@ message Command_CreateGame {
     repeated uint32 game_type_ids = 10;
     optional bool join_as_judge = 11;
     optional bool join_as_spectator = 12;
+    optional uint32 starting_life_total = 13;
 }
 
 message Command_JoinGame {

common/server_game.cpp

@@ -61,15 +61,16 @@ Server_Game::Server_Game(const ServerInfo_User &_creatorInfo,
                          bool _spectatorsNeedPassword,
                          bool _spectatorsCanTalk,
                          bool _spectatorsSeeEverything,
+                         int _startingLifeTotal,
                          Server_Room *_room)
     : QObject(), room(_room), nextPlayerId(0), hostId(0), creatorInfo(new ServerInfo_User(_creatorInfo)),
       gameStarted(false), gameClosed(false), gameId(_gameId), password(_password), maxPlayers(_maxPlayers),
       gameTypes(_gameTypes), activePlayer(-1), activePhase(-1), onlyBuddies(_onlyBuddies),
       onlyRegistered(_onlyRegistered), spectatorsAllowed(_spectatorsAllowed),
       spectatorsNeedPassword(_spectatorsNeedPassword), spectatorsCanTalk(_spectatorsCanTalk),
-      spectatorsSeeEverything(_spectatorsSeeEverything), inactivityCounter(0), startTimeOfThisGame(0),
+      spectatorsSeeEverything(_spectatorsSeeEverything), startingLifeTotal(_startingLifeTotal), inactivityCounter(0),
-      secondsElapsed(0), firstGameStarted(false), turnOrderReversed(false), startTime(QDateTime::currentDateTime()),
+      startTimeOfThisGame(0), secondsElapsed(0), firstGameStarted(false), turnOrderReversed(false),
-      pingClock(nullptr),
+      startTime(QDateTime::currentDateTime()), pingClock(nullptr),
 #if (QT_VERSION >= QT_VERSION_CHECK(5, 14, 0))
       gameMutex()
 #else

common/server_game.h

@@ -66,6 +66,7 @@ private:
     bool spectatorsNeedPassword;
     bool spectatorsCanTalk;
     bool spectatorsSeeEverything;
+    int startingLifeTotal;
     int inactivityCounter;
     int startTimeOfThisGame, secondsElapsed;
     bool firstGameStarted;
@@ -105,6 +106,7 @@ public:
                 bool _spectatorsNeedPassword,
                 bool _spectatorsCanTalk,
                 bool _spectatorsSeeEverything,
+                int startingLifeTotal,
                 Server_Room *parent);
     ~Server_Game();
     Server_Room *getRoom() const
@@ -162,6 +164,10 @@ public:
     {
         return spectatorsSeeEverything;
     }
+    int getStartingLifeTotal() const
+    {
+        return startingLifeTotal;
+    }
     Response::ResponseCode
     checkJoin(ServerInfo_User *user, const QString &_password, bool spectator, bool overrideRestrictions, bool asJudge);
     bool containsUser(const QString &userName) const;

common/server_player.cpp

@@ -178,7 +178,7 @@ void Server_Player::setupZones()
     addZone(new Server_CardZone(this, "grave", false, ServerInfo_Zone::PublicZone));
     addZone(new Server_CardZone(this, "rfg", false, ServerInfo_Zone::PublicZone));
 
-    addCounter(new Server_Counter(0, "life", makeColor(255, 255, 255), 25, 20));
+    addCounter(new Server_Counter(0, "life", makeColor(255, 255, 255), 25, game->getStartingLifeTotal()));
     addCounter(new Server_Counter(1, "w", makeColor(255, 255, 150), 20, 0));
     addCounter(new Server_Counter(2, "u", makeColor(150, 150, 255), 20, 0));
     addCounter(new Server_Counter(3, "b", makeColor(150, 150, 150), 20, 0));

common/server_protocolhandler.cpp

@@ -815,13 +815,14 @@ Server_ProtocolHandler::cmdCreateGame(const Command_CreateGame &cmd, Server_Room
     }
 
     QString description = nameFromStdString(cmd.description());
+    int startingLifeTotal = cmd.has_starting_life_total() ? cmd.starting_life_total() : 20;
 
     // When server doesn't permit registered users to exist, do not honor only-reg setting
     bool onlyRegisteredUsers = cmd.only_registered() && (server->permitUnregisteredUsers());
     Server_Game *game = new Server_Game(
         copyUserInfo(false), gameId, description, QString::fromStdString(cmd.password()), cmd.max_players(), gameTypes,
         cmd.only_buddies(), onlyRegisteredUsers, cmd.spectators_allowed(), cmd.spectators_need_password(),
-        cmd.spectators_can_talk(), cmd.spectators_see_everything(), room);
+        cmd.spectators_can_talk(), cmd.spectators_see_everything(), startingLifeTotal, room);
 
     game->addPlayer(this, rc, asSpectator, asJudge, false);
     room->addGame(game);

dbconverter/src/mocks.cpp

@@ -300,6 +300,9 @@ void SettingsCache::setSpectatorsCanSeeEverything(const bool /* _spectatorsCanSe
 void SettingsCache::setCreateGameAsSpectator(const bool /* _createGameAsSpectator */)
 {
 }
+void SettingsCache::setDefaultStartingLifeTotal(const int /* _startingLifeTotal */)
+{
+}
 void SettingsCache::setRememberGameSettings(const bool /* _rememberGameSettings */)
 {
 }

tests/carddatabase/mocks.cpp

@@ -304,6 +304,9 @@ void SettingsCache::setSpectatorsCanSeeEverything(const bool /* _spectatorsCanSe
 void SettingsCache::setCreateGameAsSpectator(const bool /* _createGameAsSpectator */)
 {
 }
+void SettingsCache::setDefaultStartingLifeTotal(const int /* _startingLifeTotal */)
+{
+}
 void SettingsCache::setRememberGameSettings(const bool /* _rememberGameSettings */)
 {
 }