The Battle for Wesnoth  1.19.4+dev
mp_create_game.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2024
3  by Mark de Wever <koraq@xs4all.nl>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #define GETTEXT_DOMAIN "wesnoth-lib"
17 
19 
20 #include "formatter.hpp"
21 #include "formula/string_utils.hpp"
22 #include "game_config.hpp"
23 #include "game_config_manager.hpp"
24 #include "gettext.hpp"
25 #include "gui/auxiliary/field.hpp"
28 #include "gui/widgets/button.hpp"
29 #include "gui/widgets/image.hpp"
30 #include "gui/widgets/listbox.hpp"
32 #include "gui/widgets/minimap.hpp"
33 #include "gui/widgets/slider.hpp"
36 #include "gui/widgets/text_box.hpp"
39 #include "log.hpp"
40 #include "map_settings.hpp"
42 #include "save_index.hpp"
43 #include "savegame.hpp"
44 
45 #include <boost/algorithm/string.hpp>
46 
47 static lg::log_domain log_mp_create("mp/create");
48 
49 #define DBG_MP LOG_STREAM(debug, log_mp_create)
50 #define WRN_MP LOG_STREAM(warn, log_mp_create)
51 #define ERR_MP LOG_STREAM(err, log_mp_create)
52 
53 namespace gui2::dialogs
54 {
55 
56 // Special retval value for loading a game
57 static const int LOAD_GAME = 100;
58 
60 
61 mp_create_game::mp_create_game(saved_game& state, bool local_mode)
62  : modal_dialog(window_id())
63  , create_engine_(state)
64  , config_engine_()
65  , options_manager_()
66  , selected_game_index_(-1)
67  , selected_rfm_index_(-1)
68  , use_map_settings_(register_bool( "use_map_settings", true,
69  []() {return prefs::get().mp_use_map_settings();},
70  [](bool v) {prefs::get().set_mp_use_map_settings(v);},
71  std::bind(&mp_create_game::update_map_settings, this)))
72  , fog_(register_bool("fog", true,
73  []() {return prefs::get().mp_fog();},
74  [](bool v) {prefs::get().set_mp_fog(v);}))
75  , shroud_(register_bool("shroud", true,
76  []() {return prefs::get().mp_shroud();},
77  [](bool v) {prefs::get().set_mp_shroud(v);}))
78  , start_time_(register_bool("random_start_time", true,
79  []() {return prefs::get().mp_random_start_time();},
80  [](bool v) {prefs::get().set_mp_random_start_time(v);}))
81  , time_limit_(register_bool("time_limit", true,
82  []() {return prefs::get().mp_countdown();},
83  [](bool v) {prefs::get().set_mp_countdown(v);},
84  std::bind(&mp_create_game::update_map_settings, this)))
85  , shuffle_sides_(register_bool("shuffle_sides", true,
86  []() {return prefs::get().shuffle_sides();},
87  [](bool v) {prefs::get().set_shuffle_sides(v);}))
88  , observers_(register_bool("observers", true,
89  []() {return prefs::get().allow_observers();},
90  [](bool v) {prefs::get().set_allow_observers(v);}))
91  , strict_sync_(register_bool("strict_sync", true))
92  , private_replay_(register_bool("private_replay", true))
93  , turns_(register_integer("turn_count", true,
94  []() {return prefs::get().mp_turns();},
95  [](int v) {prefs::get().set_mp_turns(v);}))
96  , gold_(register_integer("village_gold", true,
97  []() {return prefs::get().village_gold();},
98  [](int v) {prefs::get().set_village_gold(v);}))
99  , support_(register_integer("village_support", true,
100  []() {return prefs::get().village_support();},
101  [](int v) {prefs::get().set_village_support(v);}))
102  , experience_(register_integer("experience_modifier", true,
103  []() {return prefs::get().xp_modifier();},
104  [](int v) {prefs::get().set_xp_modifier(v);}))
105  , init_turn_limit_(register_integer("init_turn_limit", true,
106  []() {return prefs::get().countdown_init_time();},
107  [](int v) {prefs::get().set_countdown_init_time(v);}))
108  , turn_bonus_(register_integer("turn_bonus", true,
109  []() {return prefs::get().countdown_turn_bonus();},
110  [](int v) {prefs::get().set_countdown_turn_bonus(v);}))
111  , reservoir_(register_integer("reservoir", true,
112  []() {return prefs::get().countdown_reservoir_time();},
113  [](int v) {prefs::get().set_countdown_reservoir_time(v);}))
114  , action_bonus_(register_integer("action_bonus", true,
115  []() {return prefs::get().countdown_action_bonus();},
116  [](int v) {prefs::get().set_countdown_action_bonus(v);}))
117  , mod_list_()
118  , eras_menu_button_()
119  , local_mode_(local_mode)
120 {
121  level_types_ = {
122  {level_type::type::scenario, _("Scenarios")},
123  {level_type::type::campaign, _("Multiplayer Campaigns")},
124  {level_type::type::sp_campaign, _("Singleplayer Campaigns")},
125  {level_type::type::user_map, _("Custom Maps")},
126  {level_type::type::user_scenario, _("Custom Scenarios")},
127  {level_type::type::random_map, _("Random Maps")},
128  };
129 
130  level_types_.erase(std::remove_if(level_types_.begin(), level_types_.end(),
131  [this](level_type_info& type_info) {
132  return create_engine_.get_levels_by_type_unfiltered(type_info.first).empty();
133  }), level_types_.end());
134 
135  set_show_even_without_video(true);
136 
137  create_engine_.init_active_mods();
138 
139  create_engine_.get_state().clear();
140  create_engine_.get_state().classification().type = campaign_type::type::multiplayer;
141 
142  // Need to set this in the constructor, pre_show() is too late
143  set_allow_plugin_skip(false);
144 }
145 
147 {
148  find_widget<text_box>("game_name").set_value(local_mode_ ? "" : ng::configure_engine::game_name_default());
149 
151  find_widget<button>("random_map_regenerate"),
152  std::bind(&mp_create_game::regenerate_random_map, this));
153 
155  find_widget<button>("random_map_settings"),
156  std::bind(&mp_create_game::show_generator_settings, this));
157 
159  find_widget<button>("load_game"),
160  std::bind(&mp_create_game::load_game_callback, this));
161 
162  // Custom dialog close hook
164 
165  //
166  // Set up the options manager. Needs to be done before selecting an initial tab
167  //
169 
170  //
171  // Set up filtering
172  //
173  connect_signal_notify_modified(find_widget<slider>("num_players"),
174  std::bind(&mp_create_game::on_filter_change<slider>, this, "num_players", true));
175 
176  text_box& filter = find_widget<text_box>("game_filter");
177 
179  std::bind(&mp_create_game::on_filter_change<text_box>, this, "game_filter", true));
180 
181  // Note this cannot be in the keyboard chain or it will capture focus from other text boxes
182  keyboard_capture(&filter);
183 
184  //
185  // Set up game types menu_button
186  //
187  std::vector<config> game_types;
188  for(level_type_info& type_info : level_types_) {
189  game_types.emplace_back("label", type_info.second);
190  }
191 
192  if(game_types.empty()) {
193  gui2::show_transient_message("", _("No games found."));
194  throw game::error(_("No games found."));
195  }
196 
197  menu_button& game_menu_button = find_widget<menu_button>("game_types");
198 
199  // Helper to make sure the initially selected level type is valid
200  auto get_initial_type_index = [this]()->int {
201  const auto index = std::find_if(level_types_.begin(), level_types_.end(), [](level_type_info& info) {
202  return info.first == *level_type::get_enum(prefs::get().mp_level_type());
203  });
204 
205  if(index != level_types_.end()) {
206  return std::distance(level_types_.begin(), index);
207  }
208 
209  return 0;
210  };
211 
212  game_menu_button.set_values(game_types, get_initial_type_index());
213 
214  connect_signal_notify_modified(game_menu_button,
215  std::bind(&mp_create_game::update_games_list, this));
216 
217  //
218  // Set up mods list
219  //
220  mod_list_ = &find_widget<listbox>("mod_list");
221 
222  const auto& activemods = prefs::get().modifications();
225  widget_item item;
226 
227  item["label"] = mod->name;
228  data.emplace("mod_name", item);
229 
230  grid* row_grid = &mod_list_->add_row(data);
231 
232  row_grid->find_widget<toggle_panel>("panel").set_tooltip(mod->description);
233 
234  toggle_button& mog_toggle = row_grid->find_widget<toggle_button>("mod_active_state");
235 
236  if(std::find(activemods.begin(), activemods.end(), mod->id) != activemods.end()) {
237  create_engine_.active_mods().push_back(mod->id);
238  mog_toggle.set_value_bool(true);
239  }
240 
241  connect_signal_notify_modified(mog_toggle, std::bind(&mp_create_game::on_mod_toggle, this, mod->id, &mog_toggle));
242  }
243 
244  // No mods, hide the header
245  if(mod_list_->get_item_count() <= 0) {
246  find_widget<styled_widget>("mods_header").set_visible(widget::visibility::invisible);
247  }
248 
249  //
250  // Set up eras menu_button
251  //
252  eras_menu_button_ = &find_widget<menu_button>("eras");
253 
254  std::vector<config> era_names;
256  era_names.emplace_back("label", era->name, "tooltip", era->description);
257  }
258 
259  if(era_names.empty()) {
260  gui2::show_transient_message("", _("No eras found."));
261  throw config::error(_("No eras found"));
262  }
263 
264  eras_menu_button_->set_values(era_names);
265 
267  std::bind(&mp_create_game::on_era_select, this));
268 
269  const int era_selection = create_engine_.find_extra_by_id(ng::create_engine::ERA, prefs::get().mp_era());
270  if(era_selection >= 0) {
271  eras_menu_button_->set_selected(era_selection);
272  }
273 
274  on_era_select();
275 
276  //
277  // Set up random faction mode menu_button
278  //
279  const int initial_index = static_cast<int>(random_faction_mode::get_enum(prefs::get().random_faction_mode()).value_or(random_faction_mode::type::independent));
280 
281  menu_button& rfm_menu_button = find_widget<menu_button>("random_faction_mode");
282  rfm_menu_button.set_selected(initial_index);
283 
284  connect_signal_notify_modified(rfm_menu_button,
286 
288 
289  //
290  // Set up the setting status labels
291  //
292  bind_status_label<slider>(this, turns_->id());
293  bind_status_label<slider>(this, gold_->id());
294  bind_status_label<slider>(this, support_->id());
295  bind_status_label<slider>(this, experience_->id());
296  bind_status_label<slider>(this, init_turn_limit_->id());
297  bind_status_label<slider>(this, turn_bonus_->id());
298  bind_status_label<slider>(this, reservoir_->id());
299  bind_status_label<slider>(this, action_bonus_->id());
300 
301  //
302  // Timer reset button
303  //
305  find_widget<button>("reset_timer_defaults"),
306  std::bind(&mp_create_game::reset_timer_settings, this));
307 
308  //
309  // Disable certain settings if we're playing a local game.
310  //
311  if(local_mode_) {
312  find_widget<text_box>("game_name").set_active(false);
313  find_widget<text_box>("game_password").set_active(false);
314 
315  observers_->widget_set_enabled(false, false);
316  strict_sync_->widget_set_enabled(false, false);
317  private_replay_->widget_set_enabled(false, false);
318  }
319 
320  //
321  // Set up tab control
322  //
323  listbox& tab_bar = find_widget<listbox>("tab_bar");
324 
326  std::bind(&mp_create_game::on_tab_select, this));
327 
328  // Allow the settings stack to find widgets in all pages, regardless of which is selected.
329  // This ensures settings (especially game settings) widgets are appropriately updated when
330  // a new game is selected, regardless of which settings tab is active at the time.
331  find_widget<stacked_widget>("pager").set_find_in_all_layers(true);
332 
333  // We call on_tab_select farther down.
334 
335  //
336  // Main games list
337  //
338  listbox& list = find_widget<listbox>("games_list");
339 
341  std::bind(&mp_create_game::on_game_select, this));
342 
343  add_to_keyboard_chain(&list);
344 
345  // This handles the initial game selection as well
346  display_games_of_type(level_types_[get_initial_type_index()].first, prefs::get().mp_level());
347 
348  // Initial tab selection must be done after game selection so the field widgets are set to their correct active state.
349  on_tab_select();
350 
351  //
352  // Set up the Lua plugin context
353  //
354  plugins_context_.reset(new plugins_context("Multiplayer Create"));
355 
356  plugins_context_->set_callback("create", [this](const config&) { set_retval(retval::OK); }, false);
357  plugins_context_->set_callback("quit", [this](const config&) { set_retval(retval::CANCEL); }, false);
358  plugins_context_->set_callback("load", [this](const config&) { load_game_callback(); }, false);
359 
360 #define UPDATE_ATTRIBUTE(field, convert) \
361  do { if(cfg.has_attribute(#field)) { field##_->set_widget_value(cfg[#field].convert()); } } while(false) \
362 
363  plugins_context_->set_callback("update_settings", [this](const config& cfg) {
364  UPDATE_ATTRIBUTE(turns, to_int);
365  UPDATE_ATTRIBUTE(gold, to_int);
366  UPDATE_ATTRIBUTE(support, to_int);
367  UPDATE_ATTRIBUTE(experience, to_int);
368  UPDATE_ATTRIBUTE(start_time, to_bool);
369  UPDATE_ATTRIBUTE(fog, to_bool);
370  UPDATE_ATTRIBUTE(shroud, to_bool);
371  UPDATE_ATTRIBUTE(time_limit, to_bool);
372  UPDATE_ATTRIBUTE(init_turn_limit, to_int);
373  UPDATE_ATTRIBUTE(turn_bonus, to_int);
374  UPDATE_ATTRIBUTE(reservoir, to_int);
375  UPDATE_ATTRIBUTE(action_bonus, to_int);
376  UPDATE_ATTRIBUTE(observers, to_bool);
377  UPDATE_ATTRIBUTE(strict_sync, to_bool);
378  UPDATE_ATTRIBUTE(private_replay, to_bool);
379  UPDATE_ATTRIBUTE(shuffle_sides, to_bool);
380  }, true);
381 
382 #undef UPDATE_ATTRIBUTE
383 
384  plugins_context_->set_callback("set_name", [this](const config& cfg) {
385  config_engine_->set_game_name(cfg["name"]); }, true);
386 
387  plugins_context_->set_callback("set_password", [this](const config& cfg) {
388  config_engine_->set_game_password(cfg["password"]); }, true);
389 
390  plugins_context_->set_callback("select_level", [this](const config& cfg) {
391  selected_game_index_ = convert_to_game_filtered_index(cfg["index"].to_int());
393  }, true);
394 
395  plugins_context_->set_callback("select_type", [this](const config& cfg) {
396  create_engine_.set_current_level_type(level_type::get_enum(cfg["type"].str()).value_or(level_type::type::scenario)); }, true);
397 
398  plugins_context_->set_callback("select_era", [this](const config& cfg) {
399  create_engine_.set_current_era_index(cfg["index"].to_int()); }, true);
400 
401  plugins_context_->set_callback("select_mod", [this](const config& cfg) {
402  on_mod_toggle(cfg["id"].str(), nullptr);
403  }, true);
404 
405  plugins_context_->set_accessor("get_selected", [this](const config&) {
406  const ng::level& current_level = create_engine_.current_level();
407  return config {
408  "id", current_level.id(),
409  "name", current_level.name(),
410  "icon", current_level.icon(),
411  "description", current_level.description(),
412  "allow_era_choice", current_level.allow_era_choice(),
414  };
415  });
416 
417  plugins_context_->set_accessor("find_level", [this](const config& cfg) {
418  const std::string id = cfg["id"].str();
419  return config {
420  "index", create_engine_.find_level_by_id(id).second,
422  };
423  });
424 
425  plugins_context_->set_accessor_int("find_era", [this](const config& cfg) {
427  });
428 
429  plugins_context_->set_accessor_int("find_mod", [this](const config& cfg) {
431  });
432 }
433 
435 {
436  DBG_MP << "sync_with_depcheck: start";
437 
439  DBG_MP << "sync_with_depcheck: correcting era";
440  const int new_era_index = create_engine_.dependency_manager().get_era_index();
441 
442  create_engine_.set_current_era_index(new_era_index, true);
443  eras_menu_button_->set_value(new_era_index);
444  }
445 
447  DBG_MP << "sync_with_depcheck: correcting scenario";
448 
449  // Match scenario and scenario type
451  const bool different_type = new_level_index.first != create_engine_.current_level_type();
452 
453  if(new_level_index.second != -1) {
454  create_engine_.set_current_level_type(new_level_index.first);
455  create_engine_.set_current_level(new_level_index.second);
456  selected_game_index_ = new_level_index.second;
457 
458  auto& game_types_list = find_widget<menu_button>("game_types");
459  game_types_list.set_value(std::distance(level_types_.begin(), std::find_if(level_types_.begin(), level_types_.begin(), [&](const level_type_info& info){ return info.first == new_level_index.first; })));
460 
461  if(different_type) {
462  display_games_of_type(new_level_index.first, create_engine_.current_level().id());
463  } else {
464  // This function (or rather on_game_select) might be triggered by a listbox callback, in
465  // which case we cannot use display_games_of_type since it destroys the list (and its
466  // elements) which might result in segfaults. Instead, we assume that a listbox-triggered
467  // sync_with_depcheck call never changes the game type and goes to this branch instead.
468  find_widget<listbox>("games_list").select_row(new_level_index.second);
469 
470  // Override the last selection so on_game_select selects the new level
472 
473  on_game_select();
474  }
475  }
476  }
477 
479  DBG_MP << "sync_with_depcheck: correcting modifications";
481  }
482 
484  DBG_MP << "sync_with_depcheck: end";
485 }
486 
487 template<typename T>
488 void mp_create_game::on_filter_change(const std::string& id, bool do_select)
489 {
490  create_engine_.apply_level_filter(find_widget<T>(id).get_value());
491 
492  listbox& game_list = find_widget<listbox>("games_list");
493 
494  boost::dynamic_bitset<> filtered(game_list.get_item_count());
496  filtered[i] = true;
497  }
498 
499  game_list.set_row_shown(filtered);
500 
501  if(do_select) {
502  on_game_select();
503  }
504 }
505 
507 {
508  const int selected_game = find_widget<listbox>("games_list").get_selected_row();
509 
510  if(selected_game == selected_game_index_) {
511  return;
512  }
513 
514  // Convert the absolute-index get_selected_row to a relative index for the create_engine to handle
516 
518 
520 
521  update_details();
522 
523  // General settings
524  const bool can_select_era = create_engine_.current_level().allow_era_choice();
525 
526  if(!can_select_era) {
527  eras_menu_button_->set_label(_("No eras available for this game."));
528  } else {
530  }
531 
532  eras_menu_button_->set_active(can_select_era);
533 
534  // Custom options
535  options_manager_->update_game_options();
536 
537  // Game settings
539 }
540 
542 {
543  const int i = find_widget<listbox>("tab_bar").get_selected_row();
544  find_widget<stacked_widget>("pager").select_layer(i);
545 }
546 
547 void mp_create_game::on_mod_toggle(const std::string id, toggle_button* sender)
548 {
549  if(sender && (sender->get_value_bool() == create_engine_.dependency_manager().is_modification_active(id))) {
550  ERR_MP << "ignoring on_mod_toggle that is already set";
551  return;
552  }
553 
555 
557 
558  options_manager_->update_mod_options();
559 }
560 
562 {
564 
566 
568 
569  options_manager_->update_era_options();
570 }
571 
573 {
574  selected_rfm_index_ = find_widget<menu_button>("random_faction_mode").get_value();
575 }
576 
577 void mp_create_game::show_description(const std::string& new_description)
578 {
579  styled_widget& description = find_widget<styled_widget>("description");
580 
581  description.set_label(!new_description.empty() ? new_description : _("No description available."));
582  description.set_use_markup(true);
583 }
584 
586 {
587  const int index = find_widget<menu_button>("game_types").get_value();
588 
590 }
591 
593 {
595 
596  listbox& list = find_widget<listbox>("games_list");
597 
598  list.clear();
599 
602  widget_item item;
603 
604  if(type == level_type::type::campaign || type == level_type::type::sp_campaign) {
605  item["label"] = game->icon();
606  data.emplace("game_icon", item);
607  }
608 
609  item["label"] = game->name();
610  data.emplace("game_name", item);
611 
612  grid& rg = list.add_row(data);
613 
614  auto& icon = rg.find_widget<image>("game_icon");
615  if(icon.get_label().empty()) {
616  icon.set_visible(gui2::widget::visibility::invisible);
617  }
618  }
619 
620  if(!level.empty() && !list.get_rows_shown().empty()) {
621  // Recalculate which rows should be visible
622  on_filter_change<slider>("num_players", false);
623  on_filter_change<text_box>("game_filter", false);
624 
625  int level_index = create_engine_.find_level_by_id(level).second;
626  if(level_index >= 0 && std::size_t(level_index) < list.get_item_count()) {
627  list.select_row(level_index);
628  }
629  }
630 
631  const bool is_random_map = type == level_type::type::random_map;
632 
633  find_widget<button>("random_map_regenerate").set_active(is_random_map);
634  find_widget<button>("random_map_settings").set_active(is_random_map);
635 
636  // Override the last selection so on_game_select selects the new level
638 
639  on_game_select();
640 }
641 
643 {
645 
647 }
648 
650 {
652 
653  update_details();
654 }
655 
656 int mp_create_game::convert_to_game_filtered_index(const unsigned int initial_index)
657 {
658  const std::vector<std::size_t>& filtered_indices = create_engine_.get_filtered_level_indices(create_engine_.current_level_type());
659  return std::distance(filtered_indices.begin(), std::find(filtered_indices.begin(), filtered_indices.end(), initial_index));
660 }
661 
663 {
664  styled_widget& players = find_widget<styled_widget>("map_num_players");
665  styled_widget& map_size = find_widget<styled_widget>("map_size");
666 
667  if(create_engine_.current_level_type() == level_type::type::random_map) {
668  // If the current random map doesn't have data, generate it
670  create_engine_.current_level().data()["map_data"].empty() &&
671  create_engine_.current_level().data()["map_file"].empty()) {
673  }
674 
675  find_widget<button>("random_map_settings").set_active(create_engine_.generator_has_settings());
676  }
677 
679 
680  // Reset the config_engine with new values
682  config_engine_->update_initial_cfg(create_engine_.current_level().data());
683  config_engine_->set_default_values();
684 
685  // Set the title, with newlines replaced. Newlines are sometimes found in SP Campaign names
686  std::string title = create_engine_.current_level().name();
687  boost::replace_all(title, "\n", " " + font::unicode_em_dash + " ");
688  find_widget<styled_widget>("game_title").set_label(title);
689 
690 
692  case level_type::type::scenario:
693  case level_type::type::user_map:
694  case level_type::type::user_scenario:
695  case level_type::type::random_map: {
696  ng::scenario* current_scenario = dynamic_cast<ng::scenario*>(&create_engine_.current_level());
697 
698  assert(current_scenario);
699 
701 
702  find_widget<stacked_widget>("minimap_stack").select_layer(0);
703 
704  if(current_scenario->data()["map_data"].empty()) {
705  saved_game::expand_map_file(current_scenario->data());
706  current_scenario->set_metadata();
707  }
708 
709  find_widget<minimap>("minimap").set_map_data(current_scenario->data()["map_data"]);
710 
711  players.set_label(std::to_string(current_scenario->num_players()));
712  map_size.set_label(current_scenario->map_size());
713 
714  break;
715  }
716  case level_type::type::campaign:
717  case level_type::type::sp_campaign: {
718  ng::campaign* current_campaign = dynamic_cast<ng::campaign*>(&create_engine_.current_level());
719 
720  assert(current_campaign);
721 
722  create_engine_.get_state().classification().campaign = current_campaign->data()["id"].str();
723 
724  const std::string img = formatter() << current_campaign->data()["image"] << "~SCALE_INTO(265,265)";
725 
726  find_widget<stacked_widget>("minimap_stack").select_layer(1);
727  find_widget<image>("campaign_image").set_image(img);
728 
729  const int p_min = current_campaign->min_players();
730  const int p_max = current_campaign->max_players();
731 
732  if(p_max > p_min) {
733  players.set_label(VGETTEXT("number of players^$min to $max", {{"min", std::to_string(p_min)}, {"max", std::to_string(p_max)}}));
734  } else {
735  players.set_label(std::to_string(p_min));
736  }
737 
739 
740  break;
741  }
742  }
743 
744  // This needs to be at the end, since errors found expanding the map data are put into the description
746 }
747 
749 {
750  if(config_engine_->force_lock_settings()) {
751  use_map_settings_->widget_set_enabled(false, false);
753  } else {
755  }
756 
757  const bool use_map_settings = use_map_settings_->get_widget_value();
758 
759  config_engine_->set_use_map_settings(use_map_settings);
760 
761  fog_ ->widget_set_enabled(!use_map_settings, false);
762  shroud_ ->widget_set_enabled(!use_map_settings, false);
763  start_time_ ->widget_set_enabled(!use_map_settings, false);
764 
765  turns_ ->widget_set_enabled(!use_map_settings, false);
766  gold_ ->widget_set_enabled(!use_map_settings, false);
767  support_ ->widget_set_enabled(!use_map_settings, false);
768  experience_ ->widget_set_enabled(!use_map_settings, false);
769 
770  const bool time_limit = time_limit_->get_widget_value();
771 
772  init_turn_limit_->widget_set_enabled(time_limit, false);
773  turn_bonus_ ->widget_set_enabled(time_limit, false);
774  reservoir_ ->widget_set_enabled(time_limit, false);
775  action_bonus_ ->widget_set_enabled(time_limit, false);
776 
777  find_widget<button>("reset_timer_defaults").set_active(time_limit);
778 
779  if(use_map_settings) {
780  fog_ ->set_widget_value(config_engine_->fog_game_default());
781  shroud_ ->set_widget_value(config_engine_->shroud_game_default());
782  start_time_->set_widget_value(config_engine_->random_start_time_default());
783 
784  turns_ ->set_widget_value(config_engine_->num_turns_default());
785  gold_ ->set_widget_value(config_engine_->village_gold_default());
786  support_ ->set_widget_value(config_engine_->village_support_default());
787  experience_->set_widget_value(config_engine_->xp_modifier_default());
788  }
789 }
790 
792 {
794 
795  if(!load.load_multiplayer_game()) {
796  return;
797  }
798 
799  if(load.data().cancel_orders) {
801  }
802 
804 }
805 
806 std::vector<std::string> mp_create_game::get_active_mods()
807 {
808  int i = 0;
809  std::set<std::string> res;
811  if(mod_list_->get_row_grid(i)->find_widget<toggle_button>("mod_active_state").get_value_bool()) {
812  res.insert(mod->id);
813  }
814  ++i;
815  }
816  return std::vector<std::string>(res.begin(), res.end());
817 }
818 
819 void mp_create_game::set_active_mods(const std::vector<std::string>& val)
820 {
821  std::set<std::string> val2(val.begin(), val.end());
822  int i = 0;
823  std::set<std::string> res;
825  mod_list_->get_row_grid(i)->find_widget<toggle_button>("mod_active_state").set_value_bool(val2.find(mod->id) != val2.end());
826  ++i;
827  }
828 }
829 
831 {
832  // This allows the defaults to be returned by the pref getters below
837 
838  init_turn_limit_->set_widget_value(prefs::get().countdown_init_time());
839  turn_bonus_->set_widget_value(prefs::get().countdown_turn_bonus());
840  reservoir_->set_widget_value(prefs::get().countdown_reservoir_time());
841  action_bonus_->set_widget_value(prefs::get().countdown_action_bonus());
842 }
843 
845 {
847  gui2::show_transient_error_message(_("The selected game has no sides!"));
848  return false;
849  }
850 
852  std::stringstream msg;
853  // TRANSLATORS: This sentence will be followed by some details of the error, most likely the "Map could not be loaded" message from create_engine.cpp
854  msg << _("The selected game cannot be created.");
855  msg << "\n\n";
858  return false;
859  }
860 
861  if(!create_engine_.is_campaign()) {
862  return true;
863  }
864 
865  return create_engine_.select_campaign_difficulty() != "CANCEL";
866 }
867 
869 {
870  plugins_context_.reset();
871 
872  // Show all tabs so that find_widget works correctly
873  find_widget<stacked_widget>("pager").select_layer(-1);
874 
875  if(get_retval() == LOAD_GAME) {
877 
878  // We don't need the LOAD_GAME retval past this point. For convenience, reset it to OK so we can use the execute wrapper, then exit.
880  return;
881  }
882 
883  if(get_retval() == retval::OK) {
885  prefs::get().set_mp_level_type(static_cast<int>(create_engine_.current_level_type()));
886  prefs::get().set_mp_level(create_engine_.current_level().id());
887  prefs::get().set_mp_era(create_engine_.current_era().id);
888 
890 
891  if(create_engine_.current_level_type() == level_type::type::campaign ||
892  create_engine_.current_level_type() == level_type::type::sp_campaign) {
894  } else if(create_engine_.current_level_type() == level_type::type::scenario) {
896  } else {
897  // This means define= doesn't work for randomly generated scenarios
899  }
900 
902 
904 
905  std::vector<const config*> entry_points;
906  std::vector<std::string> entry_point_titles;
907 
908  const auto& tagname = create_engine_.get_state().classification().get_tagname();
909 
910  if(tagname == "scenario") {
911  const std::string first_scenario = create_engine_.current_level().data()["first_scenario"];
912  for(const config& scenario : game_config_manager::get()->game_config().child_range(tagname)) {
913  const bool is_first = scenario["id"] == first_scenario;
914  if(scenario["allow_new_game"].to_bool(false) || is_first || game_config::debug ) {
915  const std::string& title = !scenario["new_game_title"].empty()
916  ? scenario["new_game_title"]
917  : scenario["name"];
918 
919  entry_points.insert(is_first ? entry_points.begin() : entry_points.end(), &scenario);
920  entry_point_titles.insert(is_first ? entry_point_titles.begin() : entry_point_titles.end(), title);
921  }
922  }
923  }
924 
925  if(entry_points.size() > 1) {
926  gui2::dialogs::simple_item_selector dlg(_("Choose Starting Scenario"), _("Select at which point to begin this campaign."), entry_point_titles);
927 
928  dlg.set_single_button(true);
929  dlg.show();
930 
931  const config& scenario = *entry_points[dlg.selected_index()];
932 
933  create_engine_.get_state().mp_settings().hash = scenario.hash();
935  }
936 
937  config_engine_->set_use_map_settings(use_map_settings_->get_widget_value());
938 
939  if(!config_engine_->force_lock_settings()) {
940  // Max slider value (in this case, 100) means 'unlimited turns', so pass the value -1
941  const int num_turns = turns_->get_widget_value();
942  config_engine_->set_num_turns(num_turns < ::settings::turns_max ? num_turns : - 1);
943  config_engine_->set_village_gold(gold_->get_widget_value());
944  config_engine_->set_village_support(support_->get_widget_value());
945  config_engine_->set_xp_modifier(experience_->get_widget_value());
946  config_engine_->set_random_start_time(start_time_->get_widget_value());
947  config_engine_->set_fog_game(fog_->get_widget_value());
948  config_engine_->set_shroud_game(shroud_->get_widget_value());
949 
950  config_engine_->write_parameters();
951  }
952 
953  config_engine_->set_mp_countdown(time_limit_->get_widget_value());
954  config_engine_->set_mp_countdown_init_time(init_turn_limit_->get_widget_value());
955  config_engine_->set_mp_countdown_turn_bonus(turn_bonus_->get_widget_value());
956  config_engine_->set_mp_countdown_reservoir_time(reservoir_->get_widget_value());
957  config_engine_->set_mp_countdown_action_bonus(action_bonus_->get_widget_value());
958 
959  config_engine_->set_allow_observers(observers_->get_widget_value());
960  config_engine_->set_private_replay(private_replay_->get_widget_value());
961  config_engine_->set_oos_debug(strict_sync_->get_widget_value());
962  config_engine_->set_shuffle_sides(shuffle_sides_->get_widget_value());
963 
964  random_faction_mode::type type = random_faction_mode::get_enum(selected_rfm_index_).value_or(random_faction_mode::type::independent);
965  config_engine_->set_random_faction_mode(type);
966 
967  // Since we don't have a field handling this option, we need to save the value manually
968  prefs::get().set_random_faction_mode(random_faction_mode::get_string(type));
969 
970  // Save custom option settings
971  config_engine_->set_options(options_manager_->get_options_config());
972 
973  // Set game name
974  const std::string name = find_widget<text_box>("game_name").get_value();
975  if(!name.empty() && (name != ng::configure_engine::game_name_default())) {
976  config_engine_->set_game_name(name);
977  }
978 
979  // Set game password
980  const std::string password = find_widget<text_box>("game_password").get_value();
981  if(!password.empty()) {
982  config_engine_->set_game_password(password);
983  }
984  }
985 }
986 
987 } // namespace dialogs
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:172
bool empty() const
Definition: config.cpp:853
std::string hash() const
Definition: config.cpp:1287
std::ostringstream wrapper.
Definition: formatter.hpp:40
std::string get_tagname() const
std::string campaign
The id of the campaign being played.
static game_config_manager * get()
Abstract base class for all modal dialogs.
bool show(const unsigned auto_close_time=0)
Shows the window.
int get_retval() const
Returns the cached window exit code.
std::unique_ptr< ng::configure_engine > config_engine_
bool dialog_exit_hook(window &)
Dialog exit hook to bring up the difficulty dialog when starting a campaign.
std::pair< level_type::type, std::string > level_type_info
void on_mod_toggle(const std::string id, toggle_button *sender)
void display_games_of_type(level_type::type type, const std::string &level)
virtual void post_show() override
Actions to be taken after the window has been shown.
void set_active_mods(const std::vector< std::string > &val)
void show_description(const std::string &new_description)
virtual void pre_show() override
Actions to be taken before showing the window.
std::unique_ptr< mp_options_helper > options_manager_
std::vector< level_type_info > level_types_
ng::create_engine create_engine_
void on_filter_change(const std::string &id, bool do_select)
std::vector< std::string > get_active_mods()
int convert_to_game_filtered_index(const unsigned int initial_index)
field_bool * use_map_settings_
All fields are also in the normal field vector, but they need to be manually controlled as well so ad...
std::unique_ptr< plugins_context > plugins_context_
void set_single_button(bool value)
Sets whether the Cancel button should be hidden or not.
int selected_index() const
Returns the selected item index after displaying.
const std::string & id() const
Definition: field.hpp:182
void widget_set_enabled(const bool enable, const bool sync)
Enables a widget.
Definition: field.hpp:158
void set_widget_value(CT value)
Sets the value of the field.
Definition: field.hpp:343
T get_widget_value()
Gets the value of the field.
Definition: field.hpp:378
Base container class.
Definition: grid.hpp:32
The listbox class.
Definition: listbox.hpp:43
void set_row_shown(const unsigned row, const bool shown)
Makes a row visible or invisible.
Definition: listbox.cpp:135
grid & add_row(const widget_item &item, const int index=-1)
When an item in the list is selected by the user we need to update the state.
Definition: listbox.cpp:58
const grid * get_row_grid(const unsigned row) const
Returns the grid of the wanted row.
Definition: listbox.cpp:229
bool select_row(const unsigned row, const bool select=true)
Selects a row.
Definition: listbox.cpp:242
boost::dynamic_bitset get_rows_shown() const
Returns a list of visible rows.
Definition: listbox.cpp:213
void clear()
Removes all the rows in the listbox, clearing it.
Definition: listbox.cpp:117
unsigned get_item_count() const
Returns the number of items in the listbox.
Definition: listbox.cpp:123
void set_selected(unsigned selected, bool fire_event=true)
virtual void set_value(unsigned value, bool fire_event=false) override
Inherited from selectable_item.
Definition: menu_button.hpp:58
void set_values(const std::vector<::config > &values, unsigned selected=0)
virtual unsigned get_value() const override
Inherited from selectable_item.
Definition: menu_button.hpp:55
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: menu_button.cpp:74
void set_value_bool(bool value, bool fire_event=false)
void set_tooltip(const t_string &tooltip)
virtual void set_label(const t_string &text)
virtual void set_use_markup(bool use_markup)
void set_text_changed_callback(std::function< void(text_box_base *textbox, const std::string text)> cb)
Set the text_changed callback.
A widget that allows the user to input text in single line.
Definition: text_box.hpp:125
NOT_DANGLING T * find_widget(const std::string &id, const bool must_be_active, const bool must_exist)
Gets a widget with the wanted id.
Definition: widget.hpp:737
@ invisible
The user set the widget invisible, that means:
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:61
void set_retval(const int retval, const bool close_window=true)
Sets there return value of the window.
Definition: window.hpp:397
void keyboard_capture(widget *widget)
Definition: window.cpp:1220
void add_to_keyboard_chain(widget *widget)
Adds the widget to the keyboard chain.
Definition: window.cpp:1226
void set_exit_hook(exit_hook mode, std::function< bool(window &)> func)
Sets the window's exit hook.
Definition: window.hpp:451
static const std::string & type()
Static type getter that does not rely on the widget being constructed.
@ on_ok
Run hook only if result is OK.
int max_players() const
int min_players() const
static std::string game_name_default()
int find_extra_by_id(const MP_EXTRA extra_type, const std::string &id) const
std::vector< std::size_t > get_filtered_level_indices(level_type::type type) const
bool toggle_mod(const std::string &id, bool force=false)
void set_current_era_index(const std::size_t index, bool force=false)
std::string select_campaign_difficulty(int set_value=-1)
select_campaign_difficulty
bool generator_has_settings() const
std::vector< std::string > & active_mods()
bool current_level_has_side_data()
Returns true if the current level has one or more [side] tags.
bool generator_assigned() const
level_type::type current_level_type() const
std::vector< extras_metadata_ptr > & get_extras_by_type(const MP_EXTRA extra_type)
const std::vector< extras_metadata_ptr > & get_const_extras_by_type(const MP_EXTRA extra_type) const
void apply_level_filter(const std::string &name)
const depcheck::manager & dependency_manager() const
const extras_metadata & current_era() const
void set_current_level_type(const level_type::type type)
std::pair< level_type::type, int > find_level_by_id(const std::string &id) const
saved_game & get_state()
bool is_campaign() const
Wrapper to simplify the is-type-campaign-or-sp-campaign check.
void prepare_for_campaign(const std::string &difficulty="")
std::vector< level_ptr > get_levels_by_type_unfiltered(level_type::type type) const
const mp_game_settings & get_parameters()
void set_current_level(const std::size_t index)
void prepare_for_era_and_mods()
std::size_t current_era_index() const
void init_generated_level_data()
level & current_level() const
const std::string & get_scenario() const
Returns the selected scenario.
Definition: depcheck.hpp:116
int get_era_index() const
Returns the selected era.
Definition: depcheck.cpp:398
bool is_modification_active(int index) const
Tells whether a certain mod is activated.
Definition: depcheck.cpp:427
const std::vector< std::string > & get_modifications() const
Returns the enabled modifications.
Definition: depcheck.hpp:123
Base class for all level type classes.
const config & data() const
virtual bool can_launch_game() const =0
virtual std::string id() const
virtual std::string name() const
virtual void set_metadata()=0
virtual bool allow_era_choice() const
virtual std::string icon() const
virtual std::string description() const
int num_players() const
void set_metadata()
std::string map_size() const
int village_support()
int countdown_init_time()
void set_countdown_reservoir_time(int value)
void set_village_gold(int value)
void clear_countdown_init_time()
static prefs & get()
void set_countdown_action_bonus(int value)
void set_xp_modifier(int value)
int countdown_action_bonus()
void set_countdown_turn_bonus(int value)
void set_village_support(int value)
int village_gold()
void clear_countdown_turn_bonus()
void set_countdown_init_time(int value)
void clear_countdown_reservoir_time()
const std::vector< std::string > & modifications(bool mp=true)
void set_modifications(const std::vector< std::string > &value, bool mp=true)
int countdown_reservoir_time()
int countdown_turn_bonus()
int xp_modifier()
void clear_countdown_action_bonus()
game_classification & classification()
Definition: saved_game.hpp:56
mp_game_settings & mp_settings()
Multiplayer parameters for this game.
Definition: saved_game.hpp:60
void set_scenario(config scenario)
Definition: saved_game.cpp:595
static void expand_map_file(config &scenario)
reads scenario["map_file"]
Definition: saved_game.cpp:475
void cancel_orders()
Definition: saved_game.cpp:715
The class for loading a savefile.
Definition: savegame.hpp:101
static std::shared_ptr< save_index_class > default_saves_dir()
Returns an instance for managing saves in filesystem::get_saves_dir()
Definition: save_index.cpp:208
Implements some helper classes to ease adding fields to a dialog and hide the synchronization needed.
#define VGETTEXT(msgid,...)
Handy wrappers around interpolate_variables_into_string and gettext.
std::size_t i
Definition: function.cpp:1023
int w
static std::string _(const char *str)
Definition: gettext.hpp:93
Standard logging facilities (interface).
General settings and defaults for scenarios.
#define ERR_MP
#define DBG_MP
static lg::log_domain log_mp_create("mp/create")
#define UPDATE_ATTRIBUTE(field, convert)
const std::string unicode_em_dash
Definition: constants.cpp:44
Game configuration data as global variables.
Definition: build_info.cpp:61
const bool & debug
Definition: game_config.cpp:92
REGISTER_DIALOG(editor_edit_unit)
static const int LOAD_GAME
void connect_signal_notify_modified(dispatcher &dispatcher, const signal_notification &signal)
Connects a signal handler for getting a notification upon modification.
Definition: dispatcher.cpp:203
void connect_signal_mouse_left_click(dispatcher &dispatcher, const signal &signal)
Connects a signal handler for a left mouse button click.
Definition: dispatcher.cpp:177
std::vector< game_tip > load(const config &cfg)
Loads the tips from a config.
Definition: tips.cpp:36
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:36
void show_transient_error_message(const std::string &message, const std::string &image, const bool message_use_markup)
Shows a transient error message to the user.
std::map< std::string, t_string > widget_item
Definition: widget.hpp:33
void show_transient_message(const std::string &title, const std::string &message, const std::string &image, const bool message_use_markup, const bool title_use_markup)
Shows a transient message to the user.
@ OK
Dialog was closed with the OK button.
Definition: retval.hpp:35
@ CANCEL
Dialog was closed with the CANCEL button.
Definition: retval.hpp:38
Functions to load and save images from/to disk.
logger & info()
Definition: log.cpp:316
std::string img(const std::string &src, const std::string &align, const bool floating)
Definition: markup.cpp:29
const int turns_max
maximum number of turns
std::size_t index(const std::string &str, const std::size_t index)
Codepoint index corresponding to the nth character in a UTF-8 string.
Definition: unicode.cpp:70
static void msg(const char *act, debug_info &i, const char *to="", const char *result="")
Definition: debugger.cpp:109
std::string_view data
Definition: picture.cpp:178
string_enums::enum_base< random_faction_mode_defines > random_faction_mode
Base class for all the errors encountered by the engine.
Definition: exceptions.hpp:29
static std::string get_string(enum_type key)
Converts a enum to its string equivalent.
Definition: enum_base.hpp:46
static constexpr utils::optional< enum_type > get_enum(const std::string_view value)
Converts a string into its enum equivalent.
Definition: enum_base.hpp:57