The Battle for Wesnoth  1.15.0-dev
create_engine.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2013 - 2018 by Andrius Silinskas <silinskas.andrius@gmail.com>
3  Part of the Battle for Wesnoth Project http://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
16 
17 #include "filesystem.hpp"
18 #include "game_config_manager.hpp"
20 #include "preferences/game.hpp"
23 #include "log.hpp"
24 #include "map/exception.hpp"
25 #include "map/map.hpp"
26 #include "saved_game.hpp"
27 #include "wml_exception.hpp"
28 
30 #include "serialization/parser.hpp"
32 
33 #include <sstream>
34 #include <cctype>
35 
36 static lg::log_domain log_config("config");
37 #define ERR_CF LOG_STREAM(err, log_config)
38 
39 static lg::log_domain log_mp_create_engine("mp/create/engine");
40 #define WRN_MP LOG_STREAM(warn, log_mp_create_engine)
41 #define DBG_MP LOG_STREAM(debug, log_mp_create_engine)
42 
43 namespace ng {
44 
45 level::level(const config& data)
46  : data_(data)
47 {
48 }
49 
51  : level(data)
52  , map_()
53  , map_hash_()
54  , num_players_(0)
55 {
56  set_metadata();
57 }
58 
60 {
61  return map_.get() != nullptr;
62 }
63 
65 {
66  const std::string& map_data = data_["map_data"];
67 
68  try {
69  map_.reset(new gamemap(game_config_manager::get()->terrain_types(),
70  map_data));
71  } catch(const incorrect_map_format_error& e) {
72  data_["description"] = _("Map could not be loaded: ") + e.message;
73 
74  ERR_CF << "map could not be loaded: " << e.message << '\n';
75  } catch(const wml_exception& e) {
76  data_["description"] = _("Map could not be loaded.");
77 
78  ERR_CF << "map could not be loaded: " << e.dev_message << '\n';
79  }
80 
81  set_sides();
82 }
83 
84 std::string scenario::map_size() const
85 {
86  std::stringstream map_size;
87 
88  if(map_.get() != nullptr) {
89  map_size << map_->w();
91  map_size << map_->h();
92  } else {
93  map_size << _("not available.");
94  }
95 
96  return map_size.str();
97 }
98 
100 {
101  if(map_.get() != nullptr) {
102  // If there are fewer sides in the configuration than there are
103  // starting positions, then generate the additional sides
104  const int map_positions = map_->num_valid_starting_positions();
105 
106  if(!data_.has_child("side")) {
107  for(int pos = 0; pos < map_positions; ++pos) {
108  config& side = data_.add_child("side");
109  side["side"] = pos + 1;
110  side["team_name"] = "Team " + std::to_string(pos + 1);
111  side["canrecruit"] = true;
112  side["controller"] = "human";
113  }
114  }
115 
116  num_players_ = 0;
117  for(const config& scenario : data_.child_range("side")) {
118  if(scenario["allow_player"].to_bool(true)) {
119  ++num_players_;
120  }
121  }
122  }
123 }
124 
125 user_map::user_map(const config& data, const std::string& name, gamemap* map)
126  : scenario(data)
127  , name_(name)
128 {
129  if(map != nullptr) {
130  map_.reset(new gamemap(*map));
131  }
132 
133  set_metadata();
134 }
135 
137 {
138  set_sides();
139 }
140 
141 std::string user_map::description() const
142 {
143  if(!data_["description"].empty()) {
144  return data_["description"];
145  }
146 
147  // map error message
148  return _("Custom map.");
149 }
150 
152  : scenario(data)
153  , generator_data_()
154  , generate_whole_scenario_(data_.has_attribute("scenario_generation"))
155  , generator_name_(generate_whole_scenario_ ? data_["scenario_generation"] : data_["map_generation"])
156 {
157  if(!data.has_child("generator")) {
158  data_.clear();
160  data_["description"] = "Error: Random map found with missing generator information. Scenario should have a [generator] child.";
161  data_["error_message"] = "missing [generator] tag";
162  } else {
163  generator_data_ = data.child("generator");
164  }
165 
166  if(!data.has_attribute("scenario_generation") && !data.has_attribute("map_generation")) {
167  data_.clear();
169  data_["description"] = "Error: Random map found with missing generator information. Scenario should have a [generator] child.";
170  data_["error_message"] = "couldn't find 'scenario_generation' or 'map_generation' attribute";
171  }
172 }
173 
175 {
177 }
178 
180  : level(data)
181  , id_(data["id"])
182  , allow_era_choice_(level::allow_era_choice())
183  , image_label_()
184  , min_players_(2)
185  , max_players_(2)
186 {
187  if(data.has_attribute("start_year")) {
188  dates_.first = irdya_date::read_date(data["start_year"]);
189  if(data.has_attribute("end_year")) {
190  dates_.second = irdya_date::read_date(data["end_year"]);
191  } else {
192  dates_.second = dates_.first;
193  }
194  } else if(data.has_attribute("year")) {
195  dates_.first = dates_.second = irdya_date::read_date(data["year"]);
196  }
197  set_metadata();
198 }
199 
201 {
202  return !data_.empty();
203 }
204 
206 {
207  image_label_ = data_["image"].str();
208 
209  int min = data_["min_players"].to_int(2);
210  int max = data_["max_players"].to_int(2);
211 
212  min_players_ = max_players_ = min;
213 
214  if(max > min) {
215  max_players_ = max;
216  }
217 }
218 
220 {
221  data_["completed"] = preferences::is_campaign_completed(data_["id"]);
222 
223  for(auto& cfg : data_.child_range("difficulty")) {
224  cfg["completed_at"] = preferences::is_campaign_completed(data_["id"], cfg["define"]);
225  }
226 }
227 
229  : current_level_type_()
230  , current_level_index_(0)
231  , current_era_index_(0)
232  , level_name_filter_()
233  , player_count_filter_(1)
234  , type_map_()
235  , user_map_names_()
236  , user_scenario_names_()
237  , eras_()
238  , mods_()
239  , state_(state)
240  , dependency_manager_(nullptr)
241  , generator_(nullptr)
242  , selected_campaign_difficulty_()
243  , game_config_(game_config_manager::get()->game_config())
244 {
245  // Set up the type map. Do this first!
247  type_map_.emplace(level::TYPE::USER_MAP, type_list());
248  type_map_.emplace(level::TYPE::USER_SCENARIO, type_list());
249  type_map_.emplace(level::TYPE::CAMPAIGN, type_list());
250  type_map_.emplace(level::TYPE::SP_CAMPAIGN, type_list());
251  type_map_.emplace(level::TYPE::RANDOM_MAP, type_list());
252 
253  DBG_MP << "restoring game config\n";
254 
255  // Restore game config for multiplayer.
256  game_classification::CAMPAIGN_TYPE type = state_.classification().campaign_type;
257 
258  state_.clear();
259  state_.classification().campaign_type = type;
260 
261  game_config_manager::get()->load_game_config_for_create(type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER);
262 
263  // Initialize dependency_manager_ after refreshing game config.
265  game_config_, type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER));
266 
267  // TODO: the editor dir is already configurable, is the preferences value
269  nullptr, filesystem::FILE_NAME_ONLY);
270 
272  nullptr, filesystem::FILE_NAME_ONLY);
273 
274  DBG_MP << "initializing all levels, eras and mods\n";
275 
276  init_all_levels();
277  init_extras(ERA);
278  init_extras(MOD);
279 
280  state_.mp_settings().saved_game = false;
281 
282  for(const std::string& str : preferences::modifications(state_.classification().campaign_type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER)) {
283  if(game_config_.find_child("modification", "id", str)) {
284  state_.mp_settings().active_mods.push_back(str);
285  }
286  }
287 
288  dependency_manager_->try_modifications(state_.mp_settings().active_mods, true);
289 
291 }
292 
294 {
295  DBG_MP << "initializing generated level data\n";
296 
297  //DBG_MP << "current data:\n";
298  //DBG_MP << current_level().data().debug();
299 
300  random_map * cur_lev = dynamic_cast<random_map *> (&current_level());
301 
302  if(!cur_lev) {
303  WRN_MP << "Tried to initialized generated level data on a level that wasn't a random map\n";
304  return;
305  }
306 
307  try {
308  if(!cur_lev->generate_whole_scenario())
309  {
310  DBG_MP << "** replacing map ** \n";
311 
312  config data = cur_lev->data();
313 
314  data["map_data"] = generator_->create_map();
315 
316  cur_lev->set_data(data);
317 
318  } else { //scenario generation
319 
320  DBG_MP << "** replacing scenario ** \n";
321 
322  config data = generator_->create_scenario();
323 
324  // Set the scenario to have placing of sides
325  // based on the terrain they prefer
326  if(!data.has_attribute("modify_placing")) {
327  data["modify_placing"] = true;
328  }
329 
330  const std::string& description = cur_lev->data()["description"];
331  data["description"] = description;
332  saved_game::post_scenario_generation(cur_lev->data(), data);
333 
334  cur_lev->set_data(data);
335  }
336  } catch (const mapgen_exception & e) {
337  config data = cur_lev->data();
338 
339  data["error_message"] = e.what();
340 
341  cur_lev->set_data(data);
342  }
343 
344  //DBG_MP << "final data:\n";
345  //DBG_MP << current_level().data().debug();
346 }
347 
349 {
350  //
351  // We exclude campaigns from this check since they require preprocessing in order to check
352  // their side data. Since this function is used by the MP Create screen to verify side data
353  // before proceeding to Staging, this should cover most cases of false positives. It does,
354  // however, leave open the possibility of scenarios that require preprocessing before their
355  // side data is accessible, but that's an unlikely occurrence.
356  //
357  if(is_campaign()) {
358  return true;
359  }
360 
361  return current_level().data().has_child("side");
362 }
363 
365 {
366  DBG_MP << "preparing mp_game_settings for new level\n";
369 }
370 
372 {
373  state_.classification().era_define = game_config_.find_child("era", "id", get_parameters().mp_era)["define"].str();
374  for(const std::string& mod_id : get_parameters().active_mods) {
375  state_.classification().mod_defines.push_back(game_config_.find_child("modification", "id", mod_id)["define"].str());
376  }
377 }
378 
380 {
381  DBG_MP << "preparing data for scenario by reloading game config\n";
382 
383  state_.classification().scenario_define = current_level().data()["define"].str();
384 
386  config {"next_scenario", current_level().data()["id"]}
387  );
388 }
389 
390 void create_engine::prepare_for_campaign(const std::string& difficulty)
391 {
392  DBG_MP << "preparing data for campaign by reloading game config\n";
393 
394  if(!difficulty.empty()) {
395  state_.classification().difficulty = difficulty;
396  } else if(!selected_campaign_difficulty_.empty()) {
398  }
399 
400  config& current_level_data = current_level().data();
401 
402  state_.classification().campaign = current_level_data["id"].str();
403  state_.classification().campaign_name = current_level_data["name"].str();
404  state_.classification().abbrev = current_level_data["abbrev"].str();
405 
406  state_.classification().end_text = current_level_data["end_text"].str();
407  state_.classification().end_text_duration = current_level_data["end_text_duration"];
408 
409  state_.classification().campaign_define = current_level_data["define"].str();
411  utils::split(current_level_data["extra_defines"]);
412 
414  config {"next_scenario", current_level_data["first_scenario"]}
415  );
416 }
417 
419 {
420  // Verify the existence of difficulties
421  std::vector<std::string> difficulties;
422 
423  for(const config& d : current_level().data().child_range("difficulty")) {
424  difficulties.push_back(d["define"]);
425  }
426 
427  // No difficulties found. Exit
428  if(difficulties.empty()) {
429  return "";
430  }
431 
432  // One difficulty found. Use it
433  if(difficulties.size() == 1) {
434  return difficulties[0];
435  }
436 
437  // A specific difficulty value was passed
438  // Use a minimalistic interface to get the specified define
439  if(set_value != -1) {
440  if(set_value > static_cast<int>(difficulties.size())) {
441  std::cerr << "incorrect difficulty number: [" <<
442  set_value << "]. maximum is [" << difficulties.size() << "].\n";
443  return "FAIL";
444  } else if(set_value < 1) {
445  std::cerr << "incorrect difficulty number: [" <<
446  set_value << "]. minimum is [1].\n";
447  return "FAIL";
448  } else {
449  return difficulties[set_value - 1];
450  }
451  }
452 
453  // If not, let the user pick one from the prompt
454  // We don't pass the difficulties vector here because additional data is required
455  // to constrict the dialog
457  dlg.show();
458 
460 
462 }
463 
465 {
466  DBG_MP << "preparing mp_game_settings for saved game\n";
467 
469 
470  // The save might be a start-of-scenario save so make sure we have the scenario data loaded.
472  state_.mp_settings().saved_game = true;
473 }
474 
476 {
477  DBG_MP << "prepare_for_other\n";
481 }
482 
483 void create_engine::apply_level_filter(const std::string& name)
484 {
485  level_name_filter_ = name;
487 }
488 
490 {
491  player_count_filter_ = players;
493 }
494 
496 {
497  for(auto& type : type_map_) {
498  type.second.reset_filter();
499  }
500 
501  level_name_filter_ = "";
502 }
503 
505 {
507 }
508 
510 {
512 }
513 
515 {
516  try {
517  current_level_index_ = type_map_.at(current_level_type_.v).games_filtered.at(index);
518  } catch (const std::out_of_range&) {
520  }
521 
522  if(current_level_type_ == level::TYPE::RANDOM_MAP) {
523  random_map* current_random_map = dynamic_cast<random_map*>(&current_level());
524 
525  // If dynamic cast has failed then we somehow have gotten all the pointers mixed together.
526  assert(current_random_map);
527 
528  generator_.reset(current_random_map->create_map_generator());
529  } else {
530  generator_.reset(nullptr);
531  }
532 
533  if(state_.classification().campaign_type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER) {
534  dependency_manager_->try_scenario(current_level().id());
535  }
536 }
537 
538 void create_engine::set_current_era_index(const std::size_t index, bool force)
539 {
541 
542  dependency_manager_->try_era_by_index(index, force);
543 }
544 
545 bool create_engine::toggle_mod(int index, bool force)
546 {
547  force |= state_.classification().campaign_type != game_classification::CAMPAIGN_TYPE::MULTIPLAYER;
548 
549  bool is_active = dependency_manager_->is_modification_active(index);
550  dependency_manager_->try_modification_by_index(index, !is_active, force);
551 
552  state_.mp_settings().active_mods = dependency_manager_->get_modifications();
553 
554  return !is_active;
555 }
556 
558 {
559  return generator_ != nullptr;
560 }
561 
563 {
564  return generator_->allow_user_config();
565 }
566 
568 {
569  generator_->user_config();
570 }
571 
572 std::pair<level::TYPE, int> create_engine::find_level_by_id(const std::string& id) const
573 {
574  for(const auto& type : type_map_) {
575  int i = 0;
576 
577  for(const auto game : type.second.games) {
578  if(game->id() == id) {
579  return {type.first, i};
580  }
581 
582  i++;
583  }
584  }
585 
586  return {level::TYPE::SP_CAMPAIGN, -1};
587 }
588 
589 int create_engine::find_extra_by_id(const MP_EXTRA extra_type, const std::string& id) const
590 {
591  int i = 0;
592  for(extras_metadata_ptr extra : get_const_extras_by_type(extra_type)) {
593  if(extra->id == id) {
594  return i;
595  }
596  i++;
597  }
598 
599  return -1;
600 }
601 
603 {
604  state_.mp_settings().active_mods = dependency_manager_->get_modifications();
605 }
606 
607 std::vector<std::string>& create_engine::active_mods()
608 {
609  return state_.mp_settings().active_mods;
610 }
611 
612 std::vector<create_engine::extras_metadata_ptr> create_engine::active_mods_data()
613 {
614  const std::vector<extras_metadata_ptr>& mods = get_const_extras_by_type(MP_EXTRA::MOD);
615 
616  std::vector<extras_metadata_ptr> data_vec;
617  std::copy_if(mods.begin(), mods.end(), std::back_inserter(data_vec), [this](extras_metadata_ptr mod) {
618  return dependency_manager_->is_modification_active(mod->id);
619  });
620 
621  return data_vec;
622 }
623 
625 {
626  int era_index = current_level().allow_era_choice() ? current_era_index_ : 0;
627  return *eras_[era_index]->cfg;
628 }
629 
631 {
632  DBG_MP << "getting parameter values" << std::endl;
633 
634  int era_index = current_level().allow_era_choice() ? current_era_index_ : 0;
635  state_.mp_settings().mp_era = eras_[era_index]->id;
636  state_.mp_settings().mp_era_name = eras_[era_index]->name;
637 
638  return state_.mp_settings();
639 }
640 
642 {
643  if(const config& generic_multiplayer = game_config_.child("generic_multiplayer")) {
644  config gen_mp_data = generic_multiplayer;
645 
646  // User maps.
647  int dep_index_offset = 0;
648  for(std::size_t i = 0; i < user_map_names_.size(); i++)
649  {
650  config user_map_data = gen_mp_data;
651  user_map_data["map_data"] = filesystem::read_map(user_map_names_[i]);
652 
653  // Check if a file is actually a map.
654  // Note that invalid maps should be displayed in order to
655  // show error messages in the GUI.
656  bool add_map = true;
657  std::unique_ptr<gamemap> map;
658  try {
659  map.reset(new gamemap(game_config_manager::get()->terrain_types(), user_map_data["map_data"]));
660  } catch (const incorrect_map_format_error& e) {
661  user_map_data["description"] = _("Map could not be loaded: ") + e.message;
662 
663  ERR_CF << "map could not be loaded: " << e.message << '\n';
664  } catch (const wml_exception&) {
665  add_map = false;
666  dep_index_offset++;
667  }
668 
669  if(add_map) {
670  type_map_[level::TYPE::USER_MAP].games.emplace_back(new user_map(user_map_data, user_map_names_[i], map.get()));
671 
672  // Since user maps are treated as scenarios, some dependency info is required
673  config depinfo;
674  depinfo["id"] = user_map_names_[i];
675  depinfo["name"] = user_map_names_[i];
676  dependency_manager_->insert_element(depcheck::SCENARIO, depinfo, i - dep_index_offset);
677  }
678  }
679 
680  // User made scenarios.
681  dep_index_offset = 0;
682  for(std::size_t i = 0; i < user_scenario_names_.size(); i++)
683  {
684  config data;
685  try {
686  read(data, *preprocess_file(filesystem::get_user_data_dir() + "/editor/scenarios/" + user_scenario_names_[i]));
687  } catch(const config::error & e) {
688  ERR_CF << "Caught a config error while parsing user made (editor) scenarios:\n" << e.message << std::endl;
689  ERR_CF << "Skipping file: " << (filesystem::get_user_data_dir() + "/editor/scenarios/" + user_scenario_names_[i]) << std::endl;
690  continue;
691  }
692 
693  scenario_ptr new_scenario(new scenario(data));
694  if(new_scenario->id().empty()) continue;
695 
696  type_map_[level::TYPE::USER_SCENARIO].games.push_back(std::move(new_scenario));
697 
698  // Since user scenarios are treated as scenarios, some dependency info is required
699  config depinfo;
700  depinfo["id"] = data["id"];
701  depinfo["name"] = data["name"];
702  dependency_manager_->insert_element(depcheck::SCENARIO, depinfo, i - dep_index_offset++);
703  }
704  }
705 
706  // Stand-alone scenarios.
707  for(const config& data : game_config_.child_range("multiplayer"))
708  {
709  if(!data["allow_new_game"].to_bool(true))
710  continue;
711 
712  if(!data["campaign_id"].empty())
713  continue;
714 
715  if(data.has_attribute("map_generation") || data.has_attribute("scenario_generation")) {
716  type_map_[level::TYPE::RANDOM_MAP].games.emplace_back(new random_map(data));
717  } else {
718  type_map_[level::TYPE::SCENARIO].games.emplace_back(new scenario(data));
719  }
720  }
721 
722  // Campaigns.
723  for(const config& data : game_config_.child_range("campaign"))
724  {
725  const std::string& type = data["type"];
726  bool mp = state_.classification().campaign_type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER;
727 
728  if(type == "mp" || (type == "hybrid" && mp)) {
729  type_map_[level::TYPE::CAMPAIGN].games.emplace_back(new campaign(data));
730  }
731 
732  if(type == "sp" || type.empty() || (type == "hybrid" && !mp)) {
733  campaign_ptr new_sp_campaign(new campaign(data));
734  new_sp_campaign->mark_if_completed();
735 
736  type_map_[level::TYPE::SP_CAMPAIGN].games.push_back(std::move(new_sp_campaign));
737  }
738  }
739 
740  auto& sp_campaigns = type_map_[level::TYPE::SP_CAMPAIGN].games;
741 
742  // Sort sp campaigns by rank.
743  std::stable_sort(sp_campaigns.begin(), sp_campaigns.end(),
745  return a->data()["rank"].to_int(1000) < b->data()["rank"].to_int(1000);
746  }
747  );
748 }
749 
750 void create_engine::init_extras(const MP_EXTRA extra_type)
751 {
752  std::vector<extras_metadata_ptr>& extras = get_extras_by_type(extra_type);
753  const std::string extra_name = (extra_type == ERA) ? "era" : "modification";
754 
755  ng::depcheck::component_availability default_availabilty = (extra_type == ERA)
756  ? ng::depcheck::component_availability::MP
757  : ng::depcheck::component_availability::HYBRID;
758 
759  std::set<std::string> found_ids;
760  for(const config& extra : game_config_.child_range(extra_name))
761  {
762  ng::depcheck::component_availability type = extra["type"].to_enum(default_availabilty);
763  bool mp = state_.classification().campaign_type == game_classification::CAMPAIGN_TYPE::MULTIPLAYER;
764 
765  if((type != ng::depcheck::component_availability::MP || mp) && (type != ng::depcheck::component_availability::SP || !mp) )
766  {
767  if(found_ids.insert(extra["id"]).second) {
768  extras_metadata_ptr new_extras_metadata(new extras_metadata());
769  new_extras_metadata->id = extra["id"].str();
770  new_extras_metadata->name = extra["name"].str();
771  new_extras_metadata->description = extra["description"].str();
772  new_extras_metadata->cfg = &extra;
773 
774  extras.push_back(std::move(new_extras_metadata));
775  }
776  else {
777  //TODO: use a more visible error message.
778  ERR_CF << "found " << extra_name << " with id=" << extra["id"] << " twice\n";
779  }
780  }
781  }
782 }
783 
785 {
786  for(auto& type : type_map_) {
787  type.second.apply_filter(player_count_filter_, level_name_filter_);
788  }
789 }
790 
791 std::vector<create_engine::level_ptr> create_engine::get_levels_by_type_unfiltered(level::TYPE type) const
792 {
793  std::vector<level_ptr> levels;
794  for(const level_ptr lvl : type_map_.at(type.v).games) {
795  levels.push_back(lvl);
796  }
797 
798  return levels;
799 }
800 
801 std::vector<create_engine::level_ptr> create_engine::get_levels_by_type(level::TYPE type) const
802 {
803  auto& g_list = type_map_.at(type.v);
804 
805  std::vector<level_ptr> levels;
806  for(std::size_t level : g_list.games_filtered) {
807  levels.push_back(g_list.games[level]);
808  }
809 
810  return levels;
811 }
812 
814 {
815  return type_map_.at(type.v).games_filtered;
816 }
817 
818 const std::vector<create_engine::extras_metadata_ptr>&
820 {
821  return (extra_type == ERA) ? eras_ : mods_;
822 }
823 
824 std::vector<create_engine::extras_metadata_ptr>&
826 {
827  return (extra_type == ERA) ? eras_ : mods_;
828 }
829 
831 {
832  return state_;
833 }
834 
835 } // end namespace ng
TYPE
UNSCALED : image will be drawn "as is" without changing size, even in case of redraw SCALED_TO_ZOOM :...
Definition: image.hpp:181
std::string map_size() const
void check_require_scenario()
Add addon_id information if needed.
Definition: saved_game.cpp:251
unsigned int end_text_duration
for how long the end-of-campaign text is shown
#define ERR_CF
config & child(config_key_type key, int n=0)
Returns the nth child with the given key, or a reference to an invalid config if there is none...
Definition: config.cpp:423
saved_game & get_state()
void set_current_era_index(const std::size_t index, bool force=false)
std::vector< extras_metadata_ptr > mods_
std::shared_ptr< level > level_ptr
std::shared_ptr< campaign > campaign_ptr
void expand_scenario()
copies the content of a [scenario] with the correct id attribute from the game config into this objec...
Definition: saved_game.cpp:224
bool generator_assigned() const
std::vector< extras_metadata_ptr > & get_extras_by_type(const MP_EXTRA extra_type)
static help_manager manager
The help manager.
Definition: help.cpp:34
config & find_child(config_key_type key, const std::string &name, const std::string &value)
Returns the first child of tag key with a name attribute containing value.
Definition: config.cpp:789
int find_extra_by_id(const MP_EXTRA extra_type, const std::string &id) const
void set_scenario(config scenario)
Definition: saved_game.cpp:511
Add a special kind of assert to validate whether the input from WML doesn&#39;t contain any problems that...
bool has_attribute(config_key_type key) const
Definition: config.cpp:217
#define a
bool has_child(config_key_type key) const
Determine whether a config has a child or not.
Definition: config.cpp:416
static lg::log_domain log_mp_create_engine("mp/create/engine")
bool generator_has_settings() const
bool is_campaign_completed(const std::string &campaign_id)
Definition: game.cpp:323
std::vector< std::string > user_scenario_names_
const config & generator_data() const
child_itors child_range(config_key_type key)
Definition: config.cpp:366
void expand_random_scenario()
takes care of generate_map=, generate_scenario=, map= attributes This should be called before expandi...
Definition: saved_game.cpp:418
std::string campaign_name
The name of the campaign being played.
std::string mp_era_name
bool generate_whole_scenario() const
std::shared_ptr< scenario > scenario_ptr
void set_current_level(const std::size_t index)
void clear()
Definition: saved_game.cpp:730
#define WRN_MP
void set_data(const config &data)
void clear()
Definition: config.cpp:816
static void post_scenario_generation(const config &old_scenario, config &generated_scenario)
copies attributes & tags from the &#39;outer&#39; [scenario] to the scenario that is generated by scenario_genera...
Definition: saved_game.cpp:455
#define d
static lg::log_domain log_config("config")
bool show(const unsigned auto_close_time=0)
Shows the window.
const mp_game_settings & get_parameters()
std::size_t current_era_index_
void prepare_for_era_and_mods()
bool is_campaign() const
Wrapper to simplify the is-type-campaign-or-sp-campaign check.
std::vector< std::string > split(const std::string &val, const char c, const int flags)
Splits a (comma-)separated string into a vector of pieces.
bool current_level_has_side_data()
Returns true if the current level has one or more [side] tags.
std::string description() const
std::vector< std::pair< const std::string *, const stats * > > levels
Stats (and name) for each scenario. The pointers are never nullptr.
Definition: statistics.hpp:114
campaign(const config &data)
std::string select_campaign_difficulty(int set_value=-1)
select_campaign_difficulty
#define b
const config & data() const
std::map< level::TYPE, type_list > type_map_
static bool is_active(const widget *wgt)
Definition: window.cpp:1134
Pubic entry points for the MP workflow.
Definition: lobby_data.cpp:47
std::vector< extras_metadata_ptr > active_mods_data()
std::vector< std::string > active_mods
static irdya_date read_date(const std::string &date)
static game_config_manager * get()
std::string selected_campaign_difficulty_
std::string level_name_filter_
static UNUSEDNOWARN std::string _(const char *str)
Definition: gettext.hpp:89
bool toggle_mod(int index, bool force=false)
const config & curent_era_cfg() const
std::pair< irdya_date, irdya_date > dates_
saved_game & state_
virtual std::string name() const
void set_metadata()
void prepare_for_campaign(const std::string &difficulty="")
#define DBG_MP
void read(config &cfg, std::istream &in, abstract_validator *validator)
Definition: parser.cpp:612
std::string get_user_data_dir()
Definition: filesystem.cpp:749
std::unique_ptr< depcheck::manager > dependency_manager_
std::vector< level_ptr > get_levels_by_type_unfiltered(level::TYPE type) const
std::string campaign_define
If there is a define the campaign uses to customize data.
level::TYPE current_level_type_
const std::string unicode_multiplication_sign
Definition: constants.cpp:41
Encapsulates the map of the game.
Definition: map.hpp:34
std::string end_text
end-of-campaign text
bool can_launch_game() const
std::vector< level_ptr > get_levels_by_type(level::TYPE type) const
std::string selected_difficulty() const
Returns the selected difficulty define after displaying.
create_engine(saved_game &state)
std::string campaign
The id of the campaign being played.
const char * what() const noexcept
Definition: exceptions.hpp:37
std::unique_ptr< gamemap > map_
std::string image_label_
std::string generator_name() const
std::vector< std::string > & active_mods()
void apply_level_filter(const std::string &name)
void init_generated_level_data()
std::pair< level::TYPE, int > find_level_by_id(const std::string &id) const
std::string read_map(const std::string &name)
std::string era_define
If there is a define the era uses to customize data.
map_generator * create_map_generator(const std::string &name, const config &cfg)
Definition: map_create.cpp:28
void mark_if_completed()
Helper class, don&#39;t construct this directly.
std::string dev_message
The message for developers telling which problem was triggered, this shouldn&#39;t be translated...
std::string abbrev
the campaign abbreviation
scenario(const config &data)
void get_files_in_dir(const std::string &dir, std::vector< std::string > *files, std::vector< std::string > *dirs, file_name_option mode, file_filter_option filter, file_reorder_option reorder, file_tree_checksum *checksum)
Populates &#39;files&#39; with all the files and &#39;dirs&#39; with all the directories in dir.
Definition: filesystem.cpp:386
std::size_t current_level_index_
std::size_t i
Definition: function.cpp:933
std::vector< std::string > campaign_xtra_defines
more customization of data
level & current_level() const
void load_game_config_for_create(bool is_mp, bool is_test=false)
Game configuration data as global variables.
Definition: build_info.cpp:46
level(const config &data)
std::string scenario_define
If there is a define the scenario uses to customize data.
std::vector< std::string > mod_defines
If there are defines the modifications use to customize data.
CURSOR_TYPE get()
Definition: cursor.cpp:213
std::unique_ptr< map_generator > generator_
std::vector< std::string > user_map_names_
Declarations for File-IO.
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:71
config & add_child(config_key_type key)
Definition: config.cpp:479
std::string difficulty
The difficulty level the game is being played on.
std::shared_ptr< extras_metadata > extras_metadata_ptr
std::vector< extras_metadata_ptr > eras_
const std::vector< std::string > & modifications(bool mp)
Definition: game.cpp:729
void load_game_config_for_game(const game_classification &classification)
const extras_metadata & current_era() const
bool can_launch_game() const
random_map(const config &data)
game_classification & classification()
Definition: saved_game.hpp:55
map_generator * create_map_generator() const
void set_carryover_sides_start(config carryover_sides_start)
Definition: saved_game.cpp:125
Standard logging facilities (interface).
Base class for all level type classes.
const std::vector< extras_metadata_ptr > & get_const_extras_by_type(const MP_EXTRA extra_type) const
std::string message
Definition: exceptions.hpp:31
#define e
std::vector< std::size_t > get_filtered_level_indices(level::TYPE type) const
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:68
filesystem::scoped_istream preprocess_file(const std::string &fname, preproc_map *defines)
mp_game_settings & mp_settings()
Multiplayer parameters for this game.
Definition: saved_game.hpp:59
std::string hash() const
Definition: config.cpp:1275
user_map(const config &data, const std::string &name, gamemap *map)
bool empty() const
Definition: config.cpp:837
virtual bool allow_era_choice() const
const config & game_config_
Reference to the main game config.
void init_extras(const MP_EXTRA extra_type)