The Battle for Wesnoth  1.17.4+dev
menu_events.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2006 - 2022
3  by Joerg Hinrichs <joerg.hinrichs@alice-dsl.de>
4  Copyright (C) 2003 by David White <dave@whitevine.net>
5  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
6 
7  This program is free software; you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation; either version 2 of the License, or
10  (at your option) any later version.
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY.
13 
14  See the COPYING file for more details.
15 */
16 
17 /**
18  * @file
19  * Operations activated from menus/hotkeys while playing a game.
20  * E.g. Unitlist, status_table, save_game, save_map, chat, show_help, etc.
21  */
22 
23 #include "menu_events.hpp"
24 
25 #include "actions/attack.hpp"
26 #include "actions/create.hpp"
27 #include "actions/move.hpp"
28 #include "actions/undo.hpp"
29 #include "actions/vision.hpp"
30 #include "ai/manager.hpp"
31 #include "chat_command_handler.hpp"
32 #include "color.hpp"
33 #include "display_chat_manager.hpp"
34 #include "font/standard_colors.hpp"
35 #include "formula/string_utils.hpp"
36 #include "game_board.hpp"
37 #include "game_config_manager.hpp"
38 #include "game_end_exceptions.hpp"
39 #include "game_events/pump.hpp"
40 #include "preferences/game.hpp"
42 #include "game_state.hpp"
43 #include "gettext.hpp"
44 #include "gui/dialogs/chat_log.hpp"
51 #include "gui/dialogs/message.hpp"
62 #include "gui/widgets/settings.hpp"
63 #include "gui/widgets/retval.hpp"
64 #include "help/help.hpp"
65 #include "log.hpp"
66 #include "map/label.hpp"
67 #include "map/map.hpp"
68 #include "map_command_handler.hpp"
69 #include "mouse_events.hpp"
70 #include "play_controller.hpp"
73 #include "preferences/display.hpp"
74 #include "replay.hpp"
75 #include "replay_helper.hpp"
76 #include "resources.hpp"
77 #include "save_index.hpp"
78 #include "savegame.hpp"
81 #include "synced_context.hpp"
82 #include "terrain/builder.hpp"
83 #include "units/udisplay.hpp"
84 #include "units/unit.hpp"
85 #include "units/types.hpp"
86 #include "whiteboard/manager.hpp"
87 #include "sound.hpp"
88 
89 static lg::log_domain log_engine("engine");
90 #define ERR_NG LOG_STREAM(err, log_engine)
91 #define LOG_NG LOG_STREAM(info, log_engine)
92 
93 namespace events
94 {
96  : gui_(gui)
97  , pc_(pc)
98  , game_config_(game_config_manager::get()->game_config())
99  , textbox_info_()
100  , last_search_()
101  , last_search_hit_()
102 {
103 }
104 
106 {
107 }
108 
110 {
111  return pc_.gamestate();
112 }
113 
115 {
116  return gamestate().gamedata_;
117 }
118 
120 {
121  return gamestate().board_;
122 }
123 
125 {
126  return textbox_info_;
127 }
128 
130 {
131  if(!gamestate().lua_kernel_) {
132  return;
133  }
134 
137 }
138 
140 {
141  gui2::dialogs::statistics_dialog::display(board().get_team(side_num));
142 }
143 
145 {
147 }
148 
150 {
151  int selected_side;
152 
153  if(gui2::dialogs::game_stats::execute(board(), gui_->viewing_team(), selected_side)) {
154  gui_->scroll_to_leader(selected_side);
155  }
156 }
157 
159 {
160  const std::string& input_name
162 
164 
165  dlg.set_title(_("Save Map As"))
166  .set_save_mode(true)
167  .set_path(input_name)
168  .set_extension(".map");
169 
170  if(!dlg.show()) {
171  return;
172  }
173 
174  try {
176  gui2::show_transient_message("", _("Map saved."));
177  } catch(const filesystem::io_exception& e) {
178  utils::string_map symbols;
179  symbols["msg"] = e.what();
180  const std::string msg = VGETTEXT("Could not save the map: $msg", symbols);
182  }
183 }
184 
186 {
187  gui2::dialogs::preferences_dialog::display();
188  // Needed after changing fullscreen/windowed mode or display resolution
190 }
191 
193 {
194  config c;
195  c["name"] = "prototype of chat log";
196  gui2::dialogs::chat_log::display(vconfig(c), *resources::recorder);
197  // std::string text = resources::recorder->build_chat_log();
198  // gui::show_dialog(*gui_,nullptr,_("Chat Log"),"",gui::CLOSE_ONLY,nullptr,nullptr,"",&text);
199 }
200 
202 {
203  help::show_help();
204 }
205 
207 {
209  ? board().is_observer()
210  ? _("Send to observers only")
211  : _("Send to allies only")
213 }
214 
216 {
218  speak();
219 }
220 
222 {
224  speak();
225 }
226 
228 {
229  if(board().is_observer()) {
230  return !gui_->observers().empty();
231  }
232 
233  for(std::size_t n = 0; n != pc_.get_teams().size(); ++n) {
234  if(n != gui_->viewing_team() && pc_.get_teams()[gui_->viewing_team()].team_name() == pc_.get_teams()[n].team_name()
235  && pc_.get_teams()[n].is_network()) {
236  return true;
237  }
238  }
239 
240  return false;
241 }
242 
243 void menu_handler::recruit(int side_num, const map_location& last_hex)
244 {
245  std::map<const unit_type*, t_string> sample_units;
246 
247  std::set<std::string> recruits = actions::get_recruits(side_num, last_hex);
248 
249  std::vector<t_string> unknown_units;
250  for(const auto& recruit : recruits) {
252  if(!type) {
253  ERR_NG << "could not find unit '" << recruit << "'" << std::endl;
254  unknown_units.emplace_back(recruit);
255  continue;
256  }
257 
258  map_location ignored;
259  map_location recruit_hex = last_hex;
260  sample_units[type] = (can_recruit(type->id(), side_num, recruit_hex, ignored));
261  }
262  if(!unknown_units.empty()) {
263  auto unknown_ids = utils::format_conjunct_list("", unknown_units);
264  // TRANSLATORS: An error that should never happen, might happen when loading an old savegame. If there are
265  // any units that the player can recruit then their standard recruitment dialog will be shown after this
266  // error message, otherwise they'll get the "You have no units available to recruit." error after this one.
267  const auto message = VNGETTEXT("Error: there’s an unknown unit type on your recruit list: $unknown_ids",
268  "Error: there are several unknown unit types on your recruit list: $unknown_ids",
269  unknown_units.size(),
270  utils::string_map { { "unknown_ids", unknown_ids }});
271  gui2::show_transient_message("", message);
272  }
273 
274  if(sample_units.empty()) {
275  gui2::show_transient_message("", _("You have no units available to recruit."));
276  return;
277  }
278 
279  gui2::dialogs::unit_recruit dlg(sample_units, board().get_team(side_num));
280 
281  if(dlg.show()) {
282  map_location recruit_hex = last_hex;
283  const unit_type *type = dlg.get_selected_unit_type();
284  if (!type) {
285  gui2::show_transient_message("", _("No unit recruited."));
286  return;
287  }
288  do_recruit(type->id(), side_num, recruit_hex);
289  }
290 }
291 
292 void menu_handler::repeat_recruit(int side_num, const map_location& last_hex)
293 {
294  const std::string& last_recruit = board().get_team(side_num).last_recruit();
295  if(last_recruit.empty() == false) {
296  map_location recruit_hex = last_hex;
297  do_recruit(last_recruit, side_num, recruit_hex);
298  }
299 }
300 
301 // TODO: Return multiple strings here, in case more than one error applies? For
302 // example, if you start AOI S5 with 0GP and recruit a Mage, two reasons apply,
303 // leader not on keep (extrarecruit=Mage) and not enough gold.
304 t_string menu_handler::can_recruit(const std::string& name, int side_num, map_location& loc, map_location& recruited_from)
305 {
306  team& current_team = board().get_team(side_num);
307 
308  const unit_type* u_type = unit_types.find(name);
309  if(u_type == nullptr) {
310  return _("Internal error. Please report this as a bug! Details:\n")
311  + "menu_handler::can_recruit: u_type == nullptr for " + name;
312  }
313 
314  // search for the unit to be recruited in recruits
315  if(!utils::contains(actions::get_recruits(side_num, loc), name)) {
316  return VGETTEXT("You cannot recruit a $unit_type_name at this time.",
317  utils::string_map { { "unit_type_name", u_type->type_name() }});
318  }
319 
320  // TODO take a wb::future_map RAII as unit_recruit::pre_show does
321  int wb_gold = 0;
322  {
323  wb::future_map future;
324  wb_gold = (pc_.get_whiteboard() ? pc_.get_whiteboard()->get_spent_gold_for(side_num) : 0);
325  }
326  if(u_type->cost() > current_team.gold() - wb_gold)
327  {
328  if(wb_gold > 0)
329  // TRANSLATORS: "plan" refers to Planning Mode
330  return _("At this point in your plan, you will not have enough gold to recruit this unit.");
331  else
332  return _("You do not have enough gold to recruit this unit.");
333  }
334 
335  current_team.last_recruit(name);
336  const events::command_disabler disable_commands;
337 
338  {
339  wb::future_map_if_active future; /* start planned unit map scope if in planning mode */
340  std::string msg = actions::find_recruit_location(side_num, loc, recruited_from, name);
341  if(!msg.empty()) {
342  return msg;
343  }
344  } // end planned unit map scope
345 
346  return "";
347 }
348 
349 bool menu_handler::do_recruit(const std::string& name, int side_num, map_location& loc)
350 {
351  map_location recruited_from = map_location::null_location();
352  const std::string res = can_recruit(name, side_num, loc, recruited_from);
353  team& current_team = board().get_team(side_num);
354 
355  if(res.empty() && (!pc_.get_whiteboard() || !pc_.get_whiteboard()->save_recruit(name, side_num, loc))) {
356  // MP_COUNTDOWN grant time bonus for recruiting
357  current_team.set_action_bonus_count(1 + current_team.action_bonus_count());
358 
359  // Do the recruiting.
360 
361  synced_context::run_and_throw("recruit", replay_helper::get_recruit(name, loc, recruited_from));
362  return true;
363  } else if(res.empty()) {
364  return false;
365  } else {
367  return false;
368  }
369 
370 }
371 
372 void menu_handler::recall(int side_num, const map_location& last_hex)
373 {
374  if(pc_.get_disallow_recall()) {
375  gui2::show_transient_message("", _("You are separated from your soldiers and may not recall them."));
376  return;
377  }
378 
379  team& current_team = board().get_team(side_num);
380 
381  std::vector<unit_const_ptr> recall_list_team;
382  bool empty;
383  {
384  wb::future_map future; // ensures recall list has planned recalls removed
385  recall_list_team = actions::get_recalls(side_num, last_hex);
386  empty = current_team.recall_list().empty();
387  }
388 
389  DBG_WB << "menu_handler::recall: Contents of wb-modified recall list:\n";
390  for(const unit_const_ptr& unit : recall_list_team) {
391  DBG_WB << unit->name() << " [" << unit->id() << "]\n";
392  }
393 
394  if(empty) {
396  _("There are no troops available to recall.\n(You must have veteran survivors from a previous scenario.)"));
397  return;
398  }
399  if(recall_list_team.empty()) {
400  gui2::show_transient_message("", _("You currently can't recall at the highlighted location."));
401  return;
402  }
403 
404  gui2::dialogs::unit_recall dlg(recall_list_team, current_team);
405 
406  if(!dlg.show()) {
407  return;
408  }
409 
410  int res = dlg.get_selected_index();
411  if (res < 0) {
412  gui2::show_transient_message("", _("No unit recalled."));
413  return;
414  }
415  int unit_cost = current_team.recall_cost();
416 
417  // we need to check if unit has a specific recall cost
418  // if it does we use it elsewise we use the team.recall_cost()
419  // the magic number -1 is what it gets set to if the unit doesn't
420  // have a special recall_cost of its own.
421  if(recall_list_team[res]->recall_cost() > -1) {
422  unit_cost = recall_list_team[res]->recall_cost();
423  }
424 
425  int wb_gold = pc_.get_whiteboard() ? pc_.get_whiteboard()->get_spent_gold_for(side_num) : 0;
426  if(current_team.gold() - wb_gold < unit_cost) {
427  utils::string_map i18n_symbols;
428  i18n_symbols["cost"] = std::to_string(unit_cost);
429  std::string msg = VNGETTEXT("You must have at least 1 gold piece to recall a unit.",
430  "You must have at least $cost gold pieces to recall this unit.", unit_cost, i18n_symbols);
432  return;
433  }
434 
435  LOG_NG << "recall index: " << res << "\n";
436  const events::command_disabler disable_commands;
437 
438  map_location recall_location = last_hex;
440  std::string err;
441  {
443  future; // future unit map removes invisible units from map, don't do this outside of planning mode
444  err = actions::find_recall_location(side_num, recall_location, recall_from, *recall_list_team[res].get());
445  } // end planned unit map scope
446 
447  if(!err.empty()) {
449  return;
450  }
451 
452  if(!pc_.get_whiteboard()
453  || !pc_.get_whiteboard()->save_recall(*recall_list_team[res].get(), side_num, recall_location)) {
454  bool success = synced_context::run_and_throw("recall",
455  replay_helper::get_recall(recall_list_team[res]->id(), recall_location, recall_from), true, true,
457 
458  if(!success) {
459  ERR_NG << "menu_handler::recall(): Unit does not exist in the recall list." << std::endl;
460  }
461  }
462 }
463 
464 // Highlights squares that an enemy could move to on their turn, showing how many can reach each square.
465 void menu_handler::show_enemy_moves(bool ignore_units, int side_num)
466 {
467  wb::future_map future; // use unit positions as if all planned actions were executed
468 
470  const map_location& hex_under_mouse = mh.hovered_hex();
471 
473 
474  // Compute enemy movement positions
475  for(auto& u : pc_.get_units()) {
476  bool invisible = u.invisible(u.get_location());
477 
478  if(board().get_team(side_num).is_enemy(u.side()) && !gui_->fogged(u.get_location()) && !u.incapacitated()
479  && !invisible) {
480  const unit_movement_resetter move_reset(u);
481  const pathfind::paths& path
482  = pathfind::paths(u, false, true, pc_.get_teams()[gui_->viewing_team()], 0, false, ignore_units);
483 
484  gui_->highlight_another_reach(path, hex_under_mouse);
485  }
486 
487  // Need to recompute ellipses for highlighted enemy units
488  gui_->invalidate(u.get_location());
489  }
490 
491  // Find possible unit (no matter whether friend or foe) under the
492  // mouse cursor.
493  const bool selected_hex_has_unit = mh.hex_hosts_unit(hex_under_mouse);
494 
495  if(selected_hex_has_unit) {
496  // At this point, a single pixel move would remove the enemy
497  // [best possible] movements hex tiles highlights, so some
498  // prevention on normal unit mouseover movement highlight
499  // has to be toggled temporarily.
501  }
502 }
503 
505 {
506  team& current_team = board().get_team(side_num);
507  bool auto_shroud = current_team.auto_shroud_updates();
508  // If we're turning automatic shroud updates on, then commit all moves
509  if(!auto_shroud) {
510  update_shroud_now(side_num);
511  }
512 
513  // Toggle the setting and record this.
515 }
516 
517 void menu_handler::update_shroud_now(int /* side_num */)
518 {
520 }
521 
522 // Helpers for menu_handler::end_turn()
523 namespace
524 {
525 /** Returns true if @a side_num has at least one living unit. */
526 bool units_alive(int side_num, const unit_map& units)
527 {
528  for(auto& unit : units) {
529  if(unit.side() == side_num) {
530  return true;
531  }
532  }
533  return false;
534 }
535 
536 /** Returns true if @a side_num has at least one unit that can still move. */
537 bool partmoved_units(
538  int side_num, const unit_map& units, const game_board& board, const std::shared_ptr<wb::manager>& whiteb)
539 {
540  for(auto& unit : units) {
541  if(unit.side() == side_num) {
542  // @todo whiteboard should take into consideration units that have
543  // a planned move but can still plan more movement in the same turn
544  if(board.unit_can_move(unit) && !unit.user_end_turn() && (!whiteb || !whiteb->unit_has_actions(&unit)))
545  return true;
546  }
547  }
548  return false;
549 }
550 
551 /**
552  * Returns true if @a side_num has at least one unit that (can but) has not moved.
553  */
554 bool unmoved_units(
555  int side_num, const unit_map& units, const game_board& board, const std::shared_ptr<wb::manager>& whiteb)
556 {
557  for(auto& unit : units) {
558  if(unit.side() == side_num) {
559  if(board.unit_can_move(unit) && !unit.has_moved() && !unit.user_end_turn()
560  && (!whiteb || !whiteb->unit_has_actions(&unit))) {
561  return true;
562  }
563  }
564  }
565  return false;
566 }
567 
568 } // end anon namespace
569 
570 bool menu_handler::end_turn(int side_num)
571 {
572  if(!gamedata().allow_end_turn()) {
574  if(reason.empty()) {
575  reason = _("You cannot end your turn yet!");
576  }
577  gui2::show_transient_message("", reason);
578  return false;
579  }
580 
581  std::size_t team_num = static_cast<std::size_t>(side_num - 1);
582  if(team_num < pc_.get_teams().size() && pc_.get_teams()[team_num].no_turn_confirmation()) {
583  // Skip the confirmations that follow.
584  }
585  // Ask for confirmation if the player hasn't made any moves.
587  && (!pc_.get_whiteboard() || !pc_.get_whiteboard()->current_side_has_actions())
588  && units_alive(side_num, pc_.get_units())) {
589  const int res = gui2::show_message("",
590  _("You have not started your turn yet. Do you really want to end your turn?"),
592  if(res == gui2::retval::CANCEL) {
593  return false;
594  }
595  }
596  // Ask for confirmation if units still have some movement left.
597  else if(preferences::yellow_confirm() && partmoved_units(side_num, pc_.get_units(), board(), pc_.get_whiteboard())) {
598  const int res = gui2::show_message("",
599  _("Some units have movement left. Do you really want to end your turn?"),
601  if(res == gui2::retval::CANCEL) {
602  return false;
603  }
604  }
605  // Ask for confirmation if units still have all movement left.
606  else if(preferences::green_confirm() && unmoved_units(side_num, pc_.get_units(), board(), pc_.get_whiteboard())) {
607  const int res = gui2::show_message("",
608  _("Some units have not moved. Do you really want to end your turn?"),
610  if(res == gui2::retval::CANCEL) {
611  return false;
612  }
613  }
614 
615  // Auto-execute remaining whiteboard planned actions
616  // Only finish turn if they all execute successfully, i.e. no ambush, etc.
617  if(pc_.get_whiteboard() && !pc_.get_whiteboard()->allow_end_turn()) {
618  return false;
619  }
620 
621  return true;
622 }
623 
624 void menu_handler::goto_leader(int side_num)
625 {
627  const display_context& dc = gui_->get_disp_context();
628  if(i != pc_.get_units().end() && i->is_visible_to_team(dc.get_team(gui_->viewing_side()), false)) {
629  gui_->scroll_to_tile(i->get_location(), game_display::WARP);
630  }
631 }
632 
634 {
636  if(un != pc_.get_units().end()) {
638  }
639 }
640 
642 {
643  const map_location& loc = mousehandler.get_last_hex();
644  if(pc_.get_map().on_board(loc) == false || gui_->shrouded(loc)) {
645  return;
646  }
647 
648  const terrain_type& type = pc_.get_map().get_terrain_info(loc);
649  // const terrain_type& info = board().pc_.get_map().get_terrain_info(terrain);
651 }
652 
654 {
655  const unit_map::iterator un = current_unit();
656  if(un == pc_.get_units().end() || gui_->viewing_side() != un->side()) {
657  return;
658  }
659 
660  if(un->unrenamable()) {
661  return;
662  }
663 
664  std::string name = un->name();
665  const std::string title(_("Rename Unit"));
666  const std::string label(_("Name:"));
667 
668  if(gui2::dialogs::edit_text::execute(title, label, name)) {
669  resources::recorder->add_rename(name, un->get_location());
670  un->rename(name);
672  }
673 }
674 
676 {
677  const mouse_handler& mousehandler = pc_.get_mouse_handler_base();
678  const bool see_all = gui_->show_everything() || (pc_.is_replay() && pc_.get_replay_controller()->see_all());
679 
680  unit_map::iterator res = board().find_visible_unit(mousehandler.get_last_hex(), pc_.get_teams()[gui_->viewing_team()], see_all);
681  if(res != pc_.get_units().end()) {
682  return res;
683  }
684 
685  return board().find_visible_unit(mousehandler.get_selected_hex(), pc_.get_teams()[gui_->viewing_team()], see_all);
686 }
687 
688 // Helpers for create_unit()
689 namespace
690 {
691 /** Allows a function to return both a type and a gender. */
692 typedef std::tuple<const unit_type*, unit_race::GENDER, std::string> type_gender_variation;
693 
694 /**
695  * Allows the user to select a type of unit, using GUI2.
696  * (Intended for use when a unit is created in debug mode via hotkey or
697  * context menu.)
698  * @returns the selected type and gender. If this is canceled, the
699  * returned type is nullptr.
700  */
701 type_gender_variation choose_unit()
702 {
703  //
704  // The unit creation dialog makes sure unit types
705  // are properly cached.
706  //
707  gui2::dialogs::unit_create create_dlg;
708  create_dlg.show();
709 
710  if(create_dlg.no_choice()) {
711  return type_gender_variation(nullptr, unit_race::NUM_GENDERS, "");
712  }
713 
714  const std::string& ut_id = create_dlg.choice();
715  const unit_type* utp = unit_types.find(ut_id);
716  if(!utp) {
717  ERR_NG << "Create unit dialog returned nonexistent or unusable unit_type id '" << ut_id << "'." << std::endl;
718  return type_gender_variation(static_cast<const unit_type*>(nullptr), unit_race::NUM_GENDERS, "");
719  }
720  const unit_type& ut = *utp;
721 
722  unit_race::GENDER gender = create_dlg.gender();
723  // Do not try to set bad genders, may mess up l10n
724  // TODO: Is this actually necessary?
725  // (Maybe create_dlg can enforce proper gender selection?)
726  if(ut.genders().end() == std::find(ut.genders().begin(), ut.genders().end(), gender)) {
727  gender = ut.genders().front();
728  }
729 
730  return type_gender_variation(utp, gender, create_dlg.variation());
731 }
732 
733 /**
734  * Creates a unit and places it on the board.
735  * (Intended for use with any units created via debug mode.)
736  */
737 void create_and_place(game_display&,
738  const gamemap&,
739  unit_map&,
740  const map_location& loc,
741  const unit_type& u_type,
743  const std::string& variation = "")
744 {
745  synced_context::run_and_throw("debug_create_unit",
746  config {
747  "x", loc.wml_x(),
748  "y", loc.wml_y(),
749  "type", u_type.id(),
750  "gender", gender_string(gender),
751  "variation", variation,
752  }
753  );
754 }
755 
756 } // Anonymous namespace
757 
758 /**
759  * Creates a unit (in debug mode via hotkey or context menu).
760  */
762 {
763  // Save the current mouse location before popping up the choice menu (which
764  // gives time for the mouse to move, changing the location).
765  const map_location destination = mousehandler.get_last_hex();
766  assert(gui_ != nullptr);
767 
768  // Let the user select the kind of unit to create.
769  if(const auto& [type, gender, variation] = choose_unit(); type != nullptr) {
770  // Make it so.
771  create_and_place(*gui_, pc_.get_map(), pc_.get_units(), destination, *type, gender, variation);
772  }
773 }
774 
776 {
777  const map_location& loc = mousehandler.get_last_hex();
778  const unit_map::iterator i = pc_.get_units().find(loc);
779  if(i == pc_.get_units().end()) {
780  if(!pc_.get_map().is_village(loc)) {
781  return;
782  }
783 
784  // village_owner returns 0 for free village, so team 0 will get it
785  int team = board().village_owner(loc);
786  // team is 0-based so team=team::nteams() is not a team
787  // but this will make get_village free it
788  if(team > static_cast<int>(pc_.get_teams().size())) {
789  team = 0;
790  }
791  actions::get_village(loc, team);
792  } else {
793  int side = i->side();
794  ++side;
795  if(side > static_cast<int>(pc_.get_teams().size())) {
796  side = 1;
797  }
798  i->set_side(side);
799 
800  if(pc_.get_map().is_village(loc)) {
801  actions::get_village(loc, side);
802  }
803  }
804 }
805 
807 {
808  const map_location loc = mousehandler.get_last_hex();
809  synced_context::run_and_throw("debug_kill", config {"x", loc.wml_x(), "y", loc.wml_y()});
810 }
811 
812 void menu_handler::label_terrain(mouse_handler& mousehandler, bool team_only)
813 {
814  const map_location& loc = mousehandler.get_last_hex();
815  if(pc_.get_map().on_board(loc) == false) {
816  return;
817  }
818 
819  const terrain_label* old_label = gui_->labels().get_label(loc);
820  std::string label = old_label ? old_label->text() : "";
821 
822  if(gui2::dialogs::edit_label::execute(label, team_only)) {
823  std::string team_name;
824  color_t color = font::LABEL_COLOR;
825 
826  if(team_only) {
827  team_name = gui_->labels().team_name();
828  } else {
830  }
831  const terrain_label* res = gui_->labels().set_label(loc, label, gui_->viewing_team(), team_name, color);
832  if(res) {
834  }
835  }
836 }
837 
839 {
840  if(gui_->team_valid() && !board().is_observer()) {
841  const int res = gui2::show_message(
842  _("Clear Labels"),
843  _("Are you sure you want to clear map labels?"),
845  );
846 
847  if(res == gui2::retval::OK) {
848  gui_->labels().clear(gui_->current_team_name(), false);
850  }
851  }
852 }
853 
855 {
856  if(gui2::dialogs::label_settings::execute(board())) {
858  }
859 }
860 
861 void menu_handler::continue_move(mouse_handler& mousehandler, int side_num)
862 {
864  if(i == pc_.get_units().end() || !i->move_interrupted()) {
865  i = pc_.get_units().find(mousehandler.get_selected_hex());
866  if(i == pc_.get_units().end() || !i->move_interrupted()) {
867  return;
868  }
869  }
870  move_unit_to_loc(i, i->get_interrupted_move(), true, side_num, mousehandler);
871 }
872 
874  const map_location& target,
875  bool continue_move,
876  int side_num,
877  mouse_handler& mousehandler)
878 {
879  assert(ui != pc_.get_units().end());
880 
881  pathfind::marked_route route = mousehandler.get_route(&*ui, target, board().get_team(side_num));
882 
883  if(route.steps.empty()) {
884  return;
885  }
886 
887  assert(route.steps.front() == ui->get_location());
888 
889  gui_->set_route(&route);
891 
892  {
893  LOG_NG << "move_unit_to_loc " << route.steps.front() << " to " << route.steps.back() << "\n";
895  }
896 
897  mousehandler.deselect_hex();
898  gui_->set_route(nullptr);
900 }
901 
902 void menu_handler::execute_gotos(mouse_handler& mousehandler, int side)
903 {
904  // we will loop on all gotos and try to fully move a maximum of them,
905  // but we want to avoid multiple blocking of the same unit,
906  // so, if possible, it's better to first wait that the blocker move
907 
908  bool wait_blocker_move = true;
909  std::set<map_location> fully_moved;
910 
911  bool change = false;
912  bool blocked_unit = false;
913  do {
914  change = false;
915  blocked_unit = false;
916  for(auto& unit : pc_.get_units()) {
917  if(unit.side() != side || unit.movement_left() == 0) {
918  continue;
919  }
920 
921  const map_location& current_loc = unit.get_location();
922  const map_location& goto_loc = unit.get_goto();
923 
924  if(goto_loc == current_loc) {
926  continue;
927  }
928 
929  if(!pc_.get_map().on_board(goto_loc)) {
930  continue;
931  }
932 
933  // avoid pathfinding calls for finished units
934  if(fully_moved.count(current_loc)) {
935  continue;
936  }
937 
938  pathfind::marked_route route = mousehandler.get_route(&unit, goto_loc, board().get_team(side));
939 
940  if(route.steps.size() <= 1) { // invalid path
941  fully_moved.insert(current_loc);
942  continue;
943  }
944 
945  // look where we will stop this turn (turn_1 waypoint or goto)
946  map_location next_stop = goto_loc;
947  pathfind::marked_route::mark_map::const_iterator w = route.marks.begin();
948  for(; w != route.marks.end(); ++w) {
949  if(w->second.turns == 1) {
950  next_stop = w->first;
951  break;
952  }
953  }
954 
955  if(next_stop == current_loc) {
956  fully_moved.insert(current_loc);
957  continue;
958  }
959 
960  // we delay each blocked move because some other change
961  // may open a another not blocked path
962  if(pc_.get_units().count(next_stop)) {
963  blocked_unit = true;
964  if(wait_blocker_move)
965  continue;
966  }
967 
968  gui_->set_route(&route);
969 
970  {
971  LOG_NG << "execute goto from " << route.steps.front() << " to " << route.steps.back() << "\n";
972  int moves = actions::move_unit_and_record(route.steps, &pc_.get_undo_stack());
973  change = moves > 0;
974  }
975 
976  if(change) {
977  // something changed, resume waiting blocker (maybe one can move now)
978  wait_blocker_move = true;
979  }
980  }
981 
982  if(!change && wait_blocker_move) {
983  // no change when waiting, stop waiting and retry
984  wait_blocker_move = false;
985  change = true;
986  }
987  } while(change && blocked_unit);
988 
989  // erase the footsteps after movement
990  gui_->set_route(nullptr);
992 }
993 
995 {
997  gui_->invalidate_all(); // TODO can fewer tiles be invalidated?
998 }
999 
1001 {
1003  gui_->invalidate_all();
1004 }
1005 
1006 void menu_handler::unit_hold_position(mouse_handler& mousehandler, int side_num)
1007 {
1008  const unit_map::iterator un = pc_.get_units().find(mousehandler.get_selected_hex());
1009  if(un != pc_.get_units().end() && un->side() == side_num && un->movement_left() >= 0) {
1010  un->toggle_hold_position();
1011  gui_->invalidate(mousehandler.get_selected_hex());
1012 
1013  mousehandler.set_current_paths(pathfind::paths());
1014 
1015  if(un->hold_position()) {
1016  mousehandler.cycle_units(false);
1017  }
1018  }
1019 }
1020 
1021 void menu_handler::end_unit_turn(mouse_handler& mousehandler, int side_num)
1022 {
1023  const unit_map::iterator un = pc_.get_units().find(mousehandler.get_selected_hex());
1024  if(un != pc_.get_units().end() && un->side() == side_num && un->movement_left() >= 0) {
1025  un->toggle_user_end_turn();
1026  gui_->invalidate(mousehandler.get_selected_hex());
1027 
1028  mousehandler.set_current_paths(pathfind::paths());
1029 
1030  if(un->user_end_turn()) {
1031  mousehandler.cycle_units(false);
1032  }
1033 
1034  // If cycle_units hasn't found a new unit to cycle to then the original unit is still selected, but
1035  // in a state where left-clicking on it does nothing. Make it respond to mouse clicks again.
1036  if(un == pc_.get_units().find(mousehandler.get_selected_hex())) {
1037  mousehandler.deselect_hex();
1038  }
1039  }
1040 }
1041 
1043 {
1044  std::ostringstream msg;
1045  msg << _("Search");
1046  if(last_search_hit_.valid()) {
1047  msg << " [" << last_search_ << "]";
1048  }
1049  msg << ':';
1050  textbox_info_.show(gui::TEXTBOX_SEARCH, msg.str(), "", false, *gui_);
1051 }
1052 
1054 {
1055  // None of the two parameters really needs to be passed since the information belong to members of the class.
1056  // But since it makes the called method more generic, it is done anyway.
1058  textbox_info_.box()->text(), textbox_info_.check() != nullptr ? textbox_info_.check()->checked() : false);
1059 }
1060 
1061 void menu_handler::add_chat_message(const std::time_t& time,
1062  const std::string& speaker,
1063  int side,
1064  const std::string& message,
1066 {
1067  gui_->get_chat_manager().add_chat_message(time, speaker, side, message, type, false);
1068 
1070  config {
1071  "sender", preferences::login(),
1072  "message", message,
1073  "whisper", type == events::chat_handler::MESSAGE_PRIVATE,
1074  }
1075  );
1076 }
1077 
1078 // command handler for user :commands. Also understands all chat commands
1079 // via inheritance. This complicates some things a bit.
1080 class console_handler : public map_command_handler<console_handler>, private chat_command_handler
1081 {
1082 public:
1083  // convenience typedef
1086  : chmap()
1087  , chat_command_handler(menu_handler, true)
1088  , menu_handler_(menu_handler)
1089  , team_num_(menu_handler.pc_.current_side())
1090  {
1091  }
1092 
1093  using chmap::dispatch; // disambiguate
1094  using chmap::get_commands_list;
1095  using chmap::command_failed;
1096 
1097 protected:
1098  // chat_command_handler's init_map() and handlers will end up calling these.
1099  // this makes sure the commands end up in our map
1100  virtual void register_command(const std::string& cmd,
1102  const std::string& help = "",
1103  const std::string& usage = "",
1104  const std::string& flags = "")
1105  {
1106  chmap::register_command(cmd, h, help, usage, flags + "N"); // add chat commands as network_only
1107  }
1108 
1109  virtual void register_alias(const std::string& to_cmd, const std::string& cmd)
1110  {
1111  chmap::register_alias(to_cmd, cmd);
1112  }
1113 
1114  virtual std::string get_arg(unsigned i) const
1115  {
1116  return chmap::get_arg(i);
1117  }
1118 
1119  virtual std::string get_cmd() const
1120  {
1121  return chmap::get_cmd();
1122  }
1123 
1124  virtual std::string get_data(unsigned n = 1) const
1125  {
1126  return chmap::get_data(n);
1127  }
1128 
1129  // these are needed to avoid ambiguities introduced by inheriting from console_command_handler
1130  using chmap::register_command;
1131  using chmap::register_alias;
1132  using chmap::help;
1133  using chmap::is_enabled;
1134  using chmap::command_failed_need_arg;
1135 
1136  void do_refresh();
1137  void do_droid();
1138  void do_terrain();
1139  void do_idle();
1140  void do_theme();
1141  void do_control();
1142  void do_controller();
1143  void do_clear();
1144  void do_foreground();
1145  void do_layers();
1146  void do_fps();
1147  void do_benchmark();
1148  void do_save();
1149  void do_save_quit();
1150  void do_quit();
1151  void do_ignore_replay_errors();
1152  void do_nosaves();
1153  void do_next_level();
1154  void do_choose_level();
1155  void do_turn();
1156  void do_turn_limit();
1157  void do_debug();
1158  void do_nodebug();
1159  void do_lua();
1160  void do_unsafe_lua();
1161  void do_custom();
1162  void do_set_alias();
1163  void do_set_var();
1164  void do_show_var();
1165  void do_inspect();
1166  void do_control_dialog();
1167  void do_unit();
1168  // void do_buff();
1169  // void do_unbuff();
1170  void do_discover();
1171  void do_undiscover();
1172  void do_create();
1173  void do_fog();
1174  void do_shroud();
1175  void do_gold();
1176  void do_event();
1177  void do_toggle_draw_coordinates();
1178  void do_toggle_draw_terrain_codes();
1179  void do_toggle_draw_num_of_bitmaps();
1180  void do_toggle_whiteboard();
1181  void do_whiteboard_options();
1182 
1183  std::string get_flags_description() const
1184  {
1185  return _("(D) — debug only, (N) — network only, (A) — admin only");
1186  }
1187 
1188  using chat_command_handler::get_command_flags_description; // silence a warning
1189  std::string get_command_flags_description(const chmap::command& c) const
1190  {
1191  std::string space(" ");
1192  return (c.has_flag('D') ? space + _("(debug command)") : "")
1193  + (c.has_flag('N') ? space + _("(network only)") : "")
1194  + (c.has_flag('A') ? space + _("(admin only)") : "")
1195  + (c.has_flag('S') ? space + _("(not during other events)") : "");
1196  }
1197 
1198  using map::is_enabled;
1199  bool is_enabled(const chmap::command& c) const
1200  {
1201  return !((c.has_flag('D') && !game_config::debug)
1202  || (c.has_flag('N') && !menu_handler_.pc_.is_networked_mp())
1203  || (c.has_flag('A') && !mp::logged_in_as_moderator())
1204  || (c.has_flag('S') && (synced_context::get_synced_state() != synced_context::UNSYNCED || !menu_handler_.pc_.current_team().is_local())));
1205  }
1206 
1207  void print(const std::string& title, const std::string& message)
1208  {
1209  menu_handler_.add_chat_message(std::time(nullptr), title, 0, message);
1210  }
1211 
1212  void init_map()
1213  {
1214  chat_command_handler::init_map(); // grab chat_ /command handlers
1215 
1216  chmap::get_command("log")->flags = ""; // clear network-only flag from log
1217  chmap::get_command("version")->flags = ""; // clear network-only flag
1218  chmap::get_command("ignore")->flags = ""; // clear network-only flag
1219  chmap::get_command("friend")->flags = ""; // clear network-only flag
1220  chmap::get_command("remove")->flags = ""; // clear network-only flag
1221 
1222  chmap::set_cmd_prefix(":");
1223 
1224  register_command("refresh", &console_handler::do_refresh, _("Refresh gui."));
1225  register_command("droid", &console_handler::do_droid, _("Switch a side to/from AI control."),
1226  // TRANSLATORS: These are the arguments accepted by the "droid" command,
1227  // which must be a side-number and then optionally one of "on", "off" or "full".
1228  // As with the command's name, "on", "off" and "full" are hardcoded, and shouldn't change in the translation.
1229  _("[<side> [on/off/full]]\n“on” = enable but retain vision, “full” = as if it’s controlled by another player"));
1230  register_command("terrain", &console_handler::do_terrain, _("Change terrain type of current hex"),
1231  // TRANSLATORS: [both|base|overlay] are hardcoded literal arguments and shouldn't be translated.
1232  _("<terrain type> [both|base|overlay]"), "DS");
1233  register_command("idle", &console_handler::do_idle, _("Switch a side to/from idle state."),
1234  // TRANSLATORS: These are the arguments accepted by the "idle" command,
1235  // which must be a side-number and then optionally "on" or "off".
1236  // As with the command's name, "on" and "off" are hardcoded, and shouldn't change in the translation.
1237  _("command_idle^[<side> [on/off]]"));
1238  register_command("theme", &console_handler::do_theme, _("Change the in-game theme."));
1239  register_command("control", &console_handler::do_control,
1240  _("Assign control of a side to a different player or observer."), _("<side> <nickname>"), "N");
1241  register_command("controller", &console_handler::do_controller, _("Query the controller status of a side."),
1242  _("<side>"));
1243  register_command("clear", &console_handler::do_clear, _("Clear chat history."));
1244  register_command("foreground", &console_handler::do_foreground, _("Debug foreground terrain."), "", "D");
1245  register_command(
1246  "layers", &console_handler::do_layers, _("Debug layers from terrain under the mouse."), "", "D");
1247  register_command("fps", &console_handler::do_fps, _("Display and log fps (Frames Per Second)."));
1248  register_command("benchmark", &console_handler::do_benchmark, _("Similar to the 'fps' command, but also forces everything to redraw instead of only things that have changed."));
1249  register_command("save", &console_handler::do_save, _("Save game."));
1250  register_alias("save", "w");
1251  register_command("quit", &console_handler::do_quit, _("Quit game."));
1252  // Note the next value is used hardcoded in the init tests.
1253  register_alias("quit", "q!");
1254  register_command("save_quit", &console_handler::do_save_quit, _("Save and quit."));
1255  register_alias("save_quit", "wq");
1256  register_command("ignore_replay_errors", &console_handler::do_ignore_replay_errors, _("Ignore replay errors."));
1257  register_command("nosaves", &console_handler::do_nosaves, _("Disable autosaves."));
1258  register_command("next_level", &console_handler::do_next_level,
1259  _("Advance to the next scenario, or scenario identified by 'id'"), _("<id>"), "DS");
1260  register_alias("next_level", "n");
1261  register_command("choose_level", &console_handler::do_choose_level, _("Choose next scenario"), "", "DS");
1262  register_alias("choose_level", "cl");
1263  register_command("turn", &console_handler::do_turn,
1264  _("Change turn number (and time of day), or increase by one if no number is specified."), _("[turn]"),
1265  "DS");
1266  register_command("turn_limit", &console_handler::do_turn_limit,
1267  _("Change turn limit, or turn the turn limit off if no number is specified or it’s −1."), _("[limit]"),
1268  "DS");
1269  register_command("debug", &console_handler::do_debug, _("Turn debug mode on."));
1270  register_command("nodebug", &console_handler::do_nodebug, _("Turn debug mode off."), "", "D");
1271  register_command(
1272  "lua", &console_handler::do_lua, _("Execute a Lua statement."), _("<command>[;<command>...]"), "DS");
1273  register_command(
1274  "unsafe_lua", &console_handler::do_unsafe_lua, _("Grant higher privileges to Lua scripts."), "", "D");
1275  register_command("custom", &console_handler::do_custom, _("Set the command used by the custom command hotkey"),
1276  _("<command>[;<command>...]"));
1277  register_command("give_control", &console_handler::do_control_dialog,
1278  _("Invoke a dialog allowing changing control of MP sides."), "", "N");
1279  register_command("inspect", &console_handler::do_inspect, _("Launch the gamestate inspector"), "", "D");
1280  register_command(
1281  "alias", &console_handler::do_set_alias, _("Set or show alias to a command"), _("<name>[=<command>]"));
1282  register_command(
1283  "set_var", &console_handler::do_set_var, _("Set a scenario variable."), _("<var>=<value>"), "DS");
1284  register_command("show_var", &console_handler::do_show_var, _("Show a scenario variable."), _("<var>"), "D");
1285  register_command("unit", &console_handler::do_unit,
1286  // TRANSLATORS: Do not translate the word "advances"; it is a hardcoded literal argument.
1287  _("Modify a unit variable. (Only top level keys are supported, and advances=<number>.)"),
1288  _("<var>=<value>"), "DS");
1289 
1290  // register_command("buff", &console_handler::do_buff,
1291  // _("Add a trait to a unit."), "", "D");
1292  // register_command("unbuff", &console_handler::do_unbuff,
1293  // _("Remove a trait from a unit. (Does not work yet.)"), "", "D");
1294  register_command("discover", &console_handler::do_discover, _("Discover all units in help."), "");
1295  register_command("undiscover", &console_handler::do_undiscover, _("'Undiscover' all units in help."), "");
1296  register_command("create", &console_handler::do_create, _("Create a unit."), _("<unit type id>"), "DS");
1297  register_command("fog", &console_handler::do_fog, _("Toggle fog for the current player."), "", "DS");
1298  register_command("shroud", &console_handler::do_shroud, _("Toggle shroud for the current player."), "", "DS");
1299  register_command("gold", &console_handler::do_gold, _("Give gold to the current player."), _("<amount>"), "DS");
1300  register_command("throw", &console_handler::do_event, _("Fire a game event."), _("<event name>"), "DS");
1301  register_alias("throw", "fire");
1302  register_command("show_coordinates", &console_handler::do_toggle_draw_coordinates,
1303  _("Toggle overlaying of x,y coordinates on hexes."));
1304  register_alias("show_coordinates", "sc");
1305  register_command("show_terrain_codes", &console_handler::do_toggle_draw_terrain_codes,
1306  _("Toggle overlaying of terrain codes on hexes."));
1307  register_alias("show_terrain_codes", "tc");
1308  register_command("show_num_of_bitmaps", &console_handler::do_toggle_draw_num_of_bitmaps,
1309  _("Toggle overlaying of number of bitmaps on hexes."));
1310  register_alias("show_num_of_bitmaps", "bn");
1311  register_command("whiteboard", &console_handler::do_toggle_whiteboard, _("Toggle planning mode."));
1312  register_alias("whiteboard", "wb");
1313  register_command(
1314  "whiteboard_options", &console_handler::do_whiteboard_options, _("Access whiteboard options dialog."));
1315  register_alias("whiteboard_options", "wbo");
1316 
1317  if(const config& alias_list = preferences::get_alias()) {
1318  for(const config::attribute& a : alias_list.attribute_range()) {
1319  register_alias(a.second, a.first);
1320  }
1321  }
1322  }
1323 
1324 private:
1326  const unsigned int team_num_;
1327 };
1328 
1329 void menu_handler::send_chat_message(const std::string& message, bool allies_only)
1330 {
1331  config cfg;
1332  cfg["id"] = preferences::login();
1333  cfg["message"] = message;
1334  const std::time_t time = ::std::time(nullptr);
1335  std::stringstream ss;
1336  ss << time;
1337  cfg["time"] = ss.str();
1338 
1339  const int side = board().is_observer() ? 0 : gui_->viewing_side();
1340  if(!board().is_observer()) {
1341  cfg["side"] = side;
1342  }
1343 
1344  bool private_message = has_friends() && allies_only;
1345 
1346  if(private_message) {
1347  if(board().is_observer()) {
1348  cfg["to_sides"] = game_config::observer_team_name;
1349  } else {
1350  cfg["to_sides"] = pc_.get_teams()[gui_->viewing_team()].allied_human_teams();
1351  }
1352  }
1353 
1354  resources::recorder->speak(cfg);
1355 
1356  add_chat_message(time, cfg["id"], side, message,
1358 }
1359 
1360 void menu_handler::do_search(const std::string& new_search)
1361 {
1362  if(new_search.empty() == false && new_search != last_search_)
1363  last_search_ = new_search;
1364 
1365  if(last_search_.empty())
1366  return;
1367 
1368  bool found = false;
1370  // If this is a location search, just center on that location.
1371  std::vector<std::string> args = utils::split(last_search_, ',');
1372  if(args.size() == 2) {
1373  int x, y;
1374  x = lexical_cast_default<int>(args[0], 0) - 1;
1375  y = lexical_cast_default<int>(args[1], 0) - 1;
1376  if(x >= 0 && x < pc_.get_map().w() && y >= 0 && y < pc_.get_map().h()) {
1377  loc = map_location(x, y);
1378  found = true;
1379  }
1380  }
1381  // Start scanning the game map
1382  if(loc.valid() == false) {
1383  loc = map_location(pc_.get_map().w() - 1, pc_.get_map().h() - 1);
1384  }
1385 
1386  map_location start = loc;
1387  while(!found) {
1388  // Move to the next location
1389  loc.x = (loc.x + 1) % pc_.get_map().w();
1390  if(loc.x == 0)
1391  loc.y = (loc.y + 1) % pc_.get_map().h();
1392 
1393  // Search label
1394  if(!gui_->shrouded(loc)) {
1395  const terrain_label* label = gui_->labels().get_label(loc);
1396  if(label) {
1397  std::string label_text = label->text().str();
1398  if(std::search(label_text.begin(), label_text.end(), last_search_.begin(), last_search_.end(),
1400  != label_text.end()) {
1401  found = true;
1402  }
1403  }
1404  }
1405  // Search unit name
1406  if(!gui_->fogged(loc)) {
1408  if(ui != pc_.get_units().end()) {
1409  const std::string name = ui->name();
1410  if(std::search(
1411  name.begin(), name.end(), last_search_.begin(), last_search_.end(), utils::chars_equal_insensitive)
1412  != name.end()) {
1413  if(!pc_.get_teams()[gui_->viewing_team()].is_enemy(ui->side())
1414  || !ui->invisible(ui->get_location())) {
1415  found = true;
1416  }
1417  }
1418  }
1419  }
1420 
1421  if(loc == start)
1422  break;
1423  }
1424 
1425  if(found) {
1426  last_search_hit_ = loc;
1428  gui_->highlight_hex(loc);
1429  } else {
1431  // Not found, inform the player
1432  utils::string_map symbols;
1433  symbols["search"] = last_search_;
1434  const std::string msg = VGETTEXT("Could not find label or unit "
1435  "containing the string ‘$search’.",
1436  symbols);
1438  }
1439 }
1440 
1441 void menu_handler::do_command(const std::string& str)
1442 {
1443  console_handler ch(*this);
1444  ch.dispatch(str);
1445 }
1446 
1447 std::vector<std::string> menu_handler::get_commands_list()
1448 {
1449  console_handler ch(*this);
1450  // HACK: we need to call dispatch() at least once to get the
1451  // command list populated *at all*. Terrible design.
1452  // An empty command is silently ignored and has negligible
1453  // overhead, so we use that for this purpose here.
1454  ch.dispatch("");
1455  return ch.get_commands_list();
1456 }
1457 
1459 {
1462 
1463  menu_handler_.gui_->create_buttons();
1464  menu_handler_.gui_->redraw_everything();
1465 }
1466 
1468 {
1469  // :droid [<side> [on/off/full]]
1470  const std::string side_s = get_arg(1);
1471  std::string action = get_arg(2);
1472  std::transform(action.begin(), action.end(), action.begin(), tolower);
1473  // default to the current side if empty
1474  const unsigned int side = side_s.empty() ? team_num_ : lexical_cast_default<unsigned int>(side_s);
1475  const bool is_your_turn = menu_handler_.pc_.current_side() == static_cast<int>(menu_handler_.gui_->viewing_side());
1476 
1477  utils::string_map symbols;
1478  symbols["side"] = std::to_string(side);
1479 
1480  if(side < 1 || side > menu_handler_.pc_.get_teams().size()) {
1481  command_failed(VGETTEXT("Can't droid invalid side: '$side'.", symbols));
1482  return;
1483  } else if(menu_handler_.board().get_team(side).is_network()) {
1484  command_failed(VGETTEXT("Can't droid networked side: '$side'.", symbols));
1485  return;
1486  } else if(menu_handler_.board().get_team(side).is_local()) {
1487  bool changed = false;
1488 
1489  const bool is_human = menu_handler_.board().get_team(side).is_human();
1490  const bool is_droid = menu_handler_.board().get_team(side).is_droid();
1491  const bool is_proxy_human = menu_handler_.board().get_team(side).is_proxy_human();
1492  const bool is_ai = menu_handler_.board().get_team(side).is_ai();
1493 
1494  if(action == "on") {
1495  if(is_ai && !is_your_turn) {
1496  command_failed(_("It is not allowed to change a side from AI to human control when it's not your turn."));
1497  return;
1498  }
1499  if(!is_human || !is_droid) {
1500  menu_handler_.board().get_team(side).make_human();
1501  menu_handler_.board().get_team(side).make_droid();
1502  changed = true;
1503  if(is_ai) {
1504  menu_handler_.pc_.send_to_wesnothd(config {"change_controller", config {"side", side, "player", preferences::login(), "to", side_controller::human}});
1505  }
1506  print(get_cmd(), VGETTEXT("Side '$side' controller is now controlled by: AI.", symbols));
1507  } else {
1508  print(get_cmd(), VGETTEXT("Side '$side' is already droided.", symbols));
1509  }
1510  } else if(action == "off") {
1511  if(is_ai && !is_your_turn) {
1512  command_failed(_("It is not allowed to change a side from AI to human control when it's not your turn."));
1513  return;
1514  }
1515  if(!is_human || !is_proxy_human) {
1516  menu_handler_.board().get_team(side).make_human();
1517  menu_handler_.board().get_team(side).make_proxy_human();
1518  changed = true;
1519  if(is_ai) {
1520  menu_handler_.pc_.send_to_wesnothd(config {"change_controller", config {"side", side, "player", preferences::login(), "to", side_controller::human}});
1521  }
1522  print(get_cmd(), VGETTEXT("Side '$side' controller is now controlled by: human.", symbols));
1523  } else {
1524  print(get_cmd(), VGETTEXT("Side '$side' is already not droided.", symbols));
1525  }
1526  } else if(action == "full") {
1527  if(!is_your_turn) {
1528  command_failed(_("It is not allowed to change a side from human to AI control when it's not your turn."));
1529  return;
1530  }
1531  if(!is_ai || !is_droid) {
1532  menu_handler_.board().get_team(side).make_ai();
1533  menu_handler_.board().get_team(side).make_droid();
1534  changed = true;
1535  if(is_human || is_proxy_human) {
1536  menu_handler_.pc_.send_to_wesnothd(config {"change_controller", config {"side", side, "player", preferences::login(), "to", side_controller::ai}});
1537  }
1538  print(get_cmd(), VGETTEXT("Side '$side' controller is now fully controlled by: AI.", symbols));
1539  } else {
1540  print(get_cmd(), VGETTEXT("Side '$side' is already fully AI controlled.", symbols));
1541  }
1542  } else if(action == "") {
1543  if(is_ai && !is_your_turn) {
1544  command_failed(_("It is not allowed to change a side from AI to human control when it's not your turn."));
1545  return;
1546  }
1547  if(is_ai || is_droid) {
1548  menu_handler_.board().get_team(side).make_human();
1549  menu_handler_.board().get_team(side).make_proxy_human();
1550  changed = true;
1551  if(is_ai) {
1552  menu_handler_.pc_.send_to_wesnothd(config {"change_controller", config {"side", side, "player", preferences::login(), "to", side_controller::human}});
1553  }
1554  print(get_cmd(), VGETTEXT("Side '$side' controller is now controlled by: human.", symbols));
1555  } else {
1556  menu_handler_.board().get_team(side).make_human();
1557  menu_handler_.board().get_team(side).make_droid();
1558  changed = true;
1559  if(is_ai) {
1560  menu_handler_.pc_.send_to_wesnothd(config {"change_controller", config {"side", side, "player", preferences::login(), "to", side_controller::human}});
1561  }
1562  print(get_cmd(), VGETTEXT("Side '$side' controller is now controlled by: AI.", symbols));
1563  }
1564  } else {
1565  print(get_cmd(), VGETTEXT("Invalid action provided for side '$side'. Valid actions are: on, off, full.", symbols));
1566  }
1567 
1568  if(team_num_ == side && changed) {
1569  if(playsingle_controller* psc = dynamic_cast<playsingle_controller*>(&menu_handler_.pc_)) {
1570  psc->set_player_type_changed();
1571  }
1572  }
1573  }
1574  menu_handler_.textbox_info_.close();
1575 }
1576 
1578 {
1579  // :terrain [<terrain type> [both|base|overlay]]
1580  const std::string terrain_type = get_arg(1);
1581  const std::string mode_str = get_arg(2);
1582 
1583  const mouse_handler& mousehandler = menu_handler_.pc_.get_mouse_handler_base();
1584  const map_location& loc = mousehandler.get_last_hex();
1585 
1586  synced_context::run_and_throw("debug_terrain",
1587  config {
1588  "x", loc.wml_x(),
1589  "y", loc.wml_y(),
1590  "terrain_type", terrain_type,
1591  "mode_str", mode_str,
1592  }
1593  );
1594 }
1595 
1597 {
1598  // :idle [<side> [on/off]]
1599  const std::string side_s = get_arg(1);
1600  const std::string action = get_arg(2);
1601  // default to the current side if empty
1602  const unsigned int side = side_s.empty() ? team_num_ : lexical_cast_default<unsigned int>(side_s);
1603 
1604  if(side < 1 || side > menu_handler_.pc_.get_teams().size()) {
1605  utils::string_map symbols;
1606  symbols["side"] = side_s;
1607  command_failed(VGETTEXT("Can't idle invalid side: '$side'.", symbols));
1608  return;
1609  } else if(menu_handler_.board().get_team(side).is_network()) {
1610  utils::string_map symbols;
1611  symbols["side"] = std::to_string(side);
1612  command_failed(VGETTEXT("Can't idle networked side: '$side'.", symbols));
1613  return;
1614  } else if(menu_handler_.board().get_team(side).is_local_ai()) {
1615  utils::string_map symbols;
1616  symbols["side"] = std::to_string(side);
1617  command_failed(VGETTEXT("Can't idle local ai side: '$side'.", symbols));
1618  return;
1619  } else if(menu_handler_.board().get_team(side).is_local_human()) {
1620  if(menu_handler_.board().get_team(side).is_idle() ? action == " on" : action == " off") {
1621  return;
1622  }
1623  // toggle the proxy controller between idle / non idle
1624  menu_handler_.board().get_team(side).toggle_idle();
1625  if(team_num_ == side) {
1626  if(playsingle_controller* psc = dynamic_cast<playsingle_controller*>(&menu_handler_.pc_)) {
1627  psc->set_player_type_changed();
1628  }
1629  }
1630  }
1631  menu_handler_.textbox_info_.close();
1632 }
1633 
1635 {
1637 }
1638 
1640 {
1641  save_id_matches(const std::string& save_id)
1642  : save_id_(save_id)
1643  {
1644  }
1645 
1646  bool operator()(const team& t) const
1647  {
1648  return t.save_id() == save_id_;
1649  }
1650 
1651  std::string save_id_;
1652 };
1653 
1655 {
1656  // :control <side> <nick>
1657  if(!menu_handler_.pc_.is_networked_mp()) {
1658  return;
1659  }
1660 
1661  const std::string side = get_arg(1);
1662  const std::string player = get_arg(2);
1663  if(player.empty()) {
1664  command_failed_need_arg(2);
1665  return;
1666  }
1667 
1668  unsigned int side_num;
1669  try {
1670  side_num = lexical_cast<unsigned int>(side);
1671  } catch(const bad_lexical_cast&) {
1672  const auto& teams = menu_handler_.pc_.get_teams();
1673  const auto it_t = std::find_if(teams.begin(), teams.end(), save_id_matches(side));
1674 
1675  if(it_t == teams.end()) {
1676  utils::string_map symbols;
1677  symbols["side"] = side;
1678  command_failed(VGETTEXT("Can't change control of invalid side: '$side'.", symbols));
1679  return;
1680  } else {
1681  side_num = it_t->side();
1682  }
1683  }
1684 
1685  if(side_num < 1 || side_num > menu_handler_.pc_.get_teams().size()) {
1686  utils::string_map symbols;
1687  symbols["side"] = side;
1688  command_failed(VGETTEXT("Can't change control of out-of-bounds side: '$side'.", symbols));
1689  return;
1690  }
1691 
1692  menu_handler_.request_control_change(side_num, player);
1693  menu_handler_.textbox_info_.close();
1694 }
1695 
1697 {
1698  const std::string side = get_arg(1);
1699  unsigned int side_num;
1700  try {
1701  side_num = lexical_cast<unsigned int>(side);
1702  } catch(const bad_lexical_cast&) {
1703  utils::string_map symbols;
1704  symbols["side"] = side;
1705  command_failed(VGETTEXT("Can't query control of invalid side: '$side'.", symbols));
1706  return;
1707  }
1708 
1709  if(side_num < 1 || side_num > menu_handler_.pc_.get_teams().size()) {
1710  utils::string_map symbols;
1711  symbols["side"] = side;
1712  command_failed(VGETTEXT("Can't query control of out-of-bounds side: '$side'.", symbols));
1713  return;
1714  }
1715 
1716  std::string report = side_controller::get_string(menu_handler_.board().get_team(side_num).controller());
1717  if(!menu_handler_.board().get_team(side_num).is_proxy_human()) {
1718  report += " (" + side_proxy_controller::get_string(menu_handler_.board().get_team(side_num).proxy_controller()) + ")";
1719  }
1720 
1721  if(menu_handler_.board().get_team(side_num).is_network()) {
1722  report += " (networked)";
1723  }
1724 
1725  print(get_cmd(), report);
1726 }
1727 
1729 {
1730  menu_handler_.gui_->get_chat_manager().clear_chat_messages();
1731 }
1732 
1734 {
1735  menu_handler_.gui_->toggle_debug_foreground();
1736 }
1737 
1739 {
1740  display& disp = *(menu_handler_.gui_);
1741 
1742  const mouse_handler& mousehandler = menu_handler_.pc_.get_mouse_handler_base();
1743  const map_location& loc = mousehandler.get_last_hex();
1744 
1745  //
1746  // It's possible to invoke this dialog even if loc isn't a valid hex. I'm not sure
1747  // exactly how that happens, but it does seem to occur when moving the mouse outside
1748  // the window to the menu bar. Not sure if there's a bug when the set-last-hex code
1749  // in that case, but this check at least ensures the dialog is only ever shown for a
1750  // valid, on-map location. Otherwise, an assertion gets thrown.
1751  //
1752  // -- vultraz, 2017-09-21
1753  //
1754  if(disp.get_map().on_board_with_border(loc)) {
1755  gui2::dialogs::terrain_layers::display(disp, loc);
1756  }
1757 }
1758 
1760 {
1762 }
1763 
1765 {
1766  menu_handler_.gui_->toggle_benchmark();
1767 }
1768 
1770 {
1771  menu_handler_.pc_.do_consolesave(get_data());
1772 }
1773 
1775 {
1776  do_save();
1777  do_quit();
1778 }
1779 
1781 {
1783 }
1784 
1786 {
1787  game_config::ignore_replay_errors = (get_data() != "off") ? true : false;
1788 }
1789 
1791 {
1792  game_config::disable_autosave = (get_data() != "off") ? true : false;
1793 }
1794 
1796 {
1797  synced_context::run_and_throw("debug_next_level", config {"next_level", get_data()});
1798 }
1799 
1801 {
1802  std::string tag = menu_handler_.pc_.get_classification().get_tagname();
1803  std::vector<std::string> options;
1804  std::string next;
1805  if(tag != "multiplayer") {
1806  for(const config& sc : menu_handler_.game_config_.child_range(tag)) {
1807  const std::string& id = sc["id"];
1808  options.push_back(id);
1809  if(id == menu_handler_.gamedata().next_scenario()) {
1810  next = id;
1811  }
1812  }
1813  } else {
1814  // find scenarios of multiplayer campaigns
1815  // (assumes that scenarios are ordered properly in the game_config)
1816  std::string scenario_id = menu_handler_.pc_.get_mp_settings().mp_scenario;
1817  if(const config& this_scenario = menu_handler_.game_config_.find_child(tag, "id", scenario_id)) {
1818  std::string addon_id = this_scenario["addon_id"].str();
1819  for(const config& sc : menu_handler_.game_config_.child_range(tag)) {
1820  if(sc["addon_id"] == addon_id) {
1821  std::string id = sc["id"];
1822  options.push_back(id);
1823  if(id == menu_handler_.gamedata().next_scenario()) {
1824  next = id;
1825  }
1826  }
1827  }
1828  }
1829  }
1830  std::sort(options.begin(), options.end());
1831  int choice = std::distance(options.begin(), std::lower_bound(options.begin(), options.end(), next));
1832  {
1833  gui2::dialogs::simple_item_selector dlg(_("Choose Scenario (Debug!)"), "", options);
1834  dlg.set_selected_index(choice);
1835  dlg.show();
1836  choice = dlg.selected_index();
1837  }
1838 
1839  if(choice == -1) {
1840  return;
1841  }
1842 
1843  if(std::size_t(choice) < options.size()) {
1844  synced_context::run_and_throw("debug_next_level", config {"next_level", options[choice]});
1845  }
1846 }
1847 
1849 {
1850  tod_manager& tod_man = menu_handler_.gamestate().tod_manager_;
1851 
1852  int turn = tod_man.turn() + 1;
1853  const std::string& data = get_data();
1854  if(!data.empty()) {
1855  turn = lexical_cast_default<int>(data, 1);
1856  }
1857  synced_context::run_and_throw("debug_turn", config {"turn", turn});
1858 }
1859 
1861 {
1862  int limit = get_data().empty() ? -1 : lexical_cast_default<int>(get_data(), 1);
1863  synced_context::run_and_throw("debug_turn_limit", config {"turn_limit", limit});
1864 }
1865 
1867 {
1868  if(!menu_handler_.pc_.is_networked_mp() || game_config::mp_debug) {
1869  print(get_cmd(), _("Debug mode activated!"));
1870  game_config::set_debug(true);
1871  } else {
1872  command_failed(_("Debug mode not available in network games"));
1873  }
1874 }
1875 
1877 {
1878  if(game_config::debug) {
1879  print(get_cmd(), _("Debug mode deactivated!"));
1880  game_config::set_debug(false);
1881  }
1882 }
1883 
1885 {
1886  if(!menu_handler_.gamestate().lua_kernel_) {
1887  return;
1888  }
1889 
1890  synced_context::run_and_throw("debug_lua", config {"code", get_data()});
1891 }
1892 
1894 {
1895  if(!menu_handler_.gamestate().lua_kernel_) {
1896  return;
1897  }
1898 
1899  const int retval = gui2::show_message(_("WARNING! Unsafe Lua Mode"),
1900  _("Executing Lua code in in this manner opens your computer to potential security breaches from any "
1901  "malicious add-ons or other programs you may have installed.\n\n"
1902  "Do not continue unless you really know what you are doing."), gui2::dialogs::message::ok_cancel_buttons);
1903 
1904  if(retval == gui2::retval::OK) {
1905  print(get_cmd(), _("Unsafe mode enabled!"));
1906  menu_handler_.gamestate().lua_kernel_->load_package();
1907  }
1908 }
1909 
1911 {
1912  preferences::set_custom_command(get_data());
1913 }
1914 
1916 {
1917  const std::string data = get_data();
1918  const std::string::const_iterator j = std::find(data.begin(), data.end(), '=');
1919  const std::string alias(data.begin(), j);
1920  if(j != data.end()) {
1921  const std::string command(j + 1, data.end());
1922  if(!command.empty()) {
1923  register_alias(command, alias);
1924  } else {
1925  // "alias something=" deactivate this alias. We just set it
1926  // equal to itself here. Later preferences will filter empty alias.
1927  register_alias(alias, alias);
1928  }
1929  preferences::add_alias(alias, command);
1930  // directly save it for the moment, but will slow commands sequence
1932  } else {
1933  // "alias something" display its value
1934  // if no alias, will be "'something' = 'something'"
1935  const std::string command = chmap::get_actual_cmd(alias);
1936  print(get_cmd(), "'" + alias + "'" + " = " + "'" + command + "'");
1937  }
1938 }
1939 
1941 {
1942  const std::string data = get_data();
1943  if(data.empty()) {
1944  command_failed_need_arg(1);
1945  return;
1946  }
1947 
1948  const std::string::const_iterator j = std::find(data.begin(), data.end(), '=');
1949  if(j != data.end()) {
1950  const std::string name(data.begin(), j);
1951  const std::string value(j + 1, data.end());
1952  synced_context::run_and_throw("debug_set_var", config {"name", name, "value", value});
1953  } else {
1954  command_failed(_("Variable not found"));
1955  }
1956 }
1957 
1959 {
1960  gui2::show_transient_message("", menu_handler_.gamedata().get_variable_const(get_data()));
1961 }
1962 
1964 {
1966  gui2::dialogs::gamestate_inspector::display(
1967  menu_handler_.gamedata().get_variables(), *resources::game_events, menu_handler_.board());
1968 }
1969 
1971 {
1972  gui2::dialogs::mp_change_control::display(menu_handler_);
1973 }
1974 
1976 {
1977  // prevent SIGSEGV due to attempt to set HP during a fight
1978  if(events::commands_disabled > 0) {
1979  return;
1980  }
1981 
1982  unit_map::iterator i = menu_handler_.current_unit();
1983  if(i == menu_handler_.pc_.get_units().end()) {
1984  return;
1985  }
1986 
1987  const map_location loc = i->get_location();
1988  const std::string data = get_data(1);
1989  std::vector<std::string> parameters = utils::split(data, '=', utils::STRIP_SPACES);
1990  if(parameters.size() < 2) {
1991  return;
1992  }
1993 
1994  if(parameters[0] == "alignment") {
1995  auto alignment = unit_alignments::get_enum(parameters[1]);
1996  if(!alignment) {
1997  utils::string_map symbols;
1998  symbols["alignment"] = get_arg(1);
1999  command_failed(VGETTEXT(
2000  "Invalid alignment: '$alignment', needs to be one of lawful, neutral, chaotic, or liminal.",
2001  symbols));
2002  return;
2003  }
2004  }
2005 
2006  synced_context::run_and_throw("debug_unit",
2007  config {
2008  "x", loc.wml_x(),
2009  "y", loc.wml_y(),
2010  "name", parameters[0],
2011  "value", parameters[1],
2012  }
2013  );
2014 }
2015 
2017 {
2018  for(const unit_type_data::unit_type_map::value_type& i : unit_types.types()) {
2019  preferences::encountered_units().insert(i.second.id());
2020  }
2021 }
2022 
2024 {
2025  const int res = gui2::show_message("Undiscover",
2026  _("Do you wish to clear all of your discovered units from help?"), gui2::dialogs::message::yes_no_buttons);
2027  if(res != gui2::retval::CANCEL) {
2029  }
2030 }
2031 
2032 /** Implements the (debug mode) console command that creates a unit. */
2034 {
2035  const mouse_handler& mousehandler = menu_handler_.pc_.get_mouse_handler_base();
2036  const map_location& loc = mousehandler.get_last_hex();
2037  if(menu_handler_.pc_.get_map().on_board(loc)) {
2038  const unit_type* ut = unit_types.find(get_data());
2039  if(!ut) {
2040  command_failed(_("Invalid unit type"));
2041  return;
2042  }
2043 
2044  // Create the unit.
2045  create_and_place(*menu_handler_.gui_, menu_handler_.pc_.get_map(), menu_handler_.pc_.get_units(), loc, *ut);
2046  } else {
2047  command_failed(_("Invalid location"));
2048  }
2049 }
2050 
2052 {
2053  synced_context::run_and_throw("debug_fog", config());
2054 }
2055 
2057 {
2058  synced_context::run_and_throw("debug_shroud", config());
2059 }
2060 
2062 {
2063  synced_context::run_and_throw("debug_gold", config {"gold", lexical_cast_default<int>(get_data(), 1000)});
2064 }
2065 
2067 {
2068  synced_context::run_and_throw("debug_event", config {"eventname", get_data()});
2069 }
2070 
2072 {
2073  menu_handler_.gui_->set_draw_coordinates(!menu_handler_.gui_->get_draw_coordinates());
2074  menu_handler_.gui_->invalidate_all();
2075 }
2077 {
2078  menu_handler_.gui_->set_draw_terrain_codes(!menu_handler_.gui_->get_draw_terrain_codes());
2079  menu_handler_.gui_->invalidate_all();
2080 }
2081 
2083 {
2084  menu_handler_.gui_->set_draw_num_of_bitmaps(!menu_handler_.gui_->get_draw_num_of_bitmaps());
2085  menu_handler_.gui_->invalidate_all();
2086 }
2087 
2089 {
2090  if(const std::shared_ptr<wb::manager>& whiteb = menu_handler_.pc_.get_whiteboard()) {
2091  whiteb->set_active(!whiteb->is_active());
2092  if(whiteb->is_active()) {
2093  print(get_cmd(), _("Planning mode activated!"));
2094  whiteb->print_help_once();
2095  } else {
2096  print(get_cmd(), _("Planning mode deactivated!"));
2097  }
2098  }
2099 }
2100 
2102 {
2103  if(menu_handler_.pc_.get_whiteboard()) {
2104  menu_handler_.pc_.get_whiteboard()->options_dlg();
2105  }
2106 }
2107 
2108 void menu_handler::do_ai_formula(const std::string& str, int side_num, mouse_handler& /*mousehandler*/)
2109 {
2110  try {
2111  add_chat_message(std::time(nullptr), "wfl", 0, ai::manager::get_singleton().evaluate_command(side_num, str));
2112  } catch(const wfl::formula_error&) {
2113  } catch(...) {
2114  add_chat_message(std::time(nullptr), "wfl", 0, "UNKNOWN ERROR IN FORMULA");
2115  }
2116 }
2117 
2119 {
2120  textbox_info_.show(gui::TEXTBOX_COMMAND, translation::sgettext("prompt^Command:"), "", false, *gui_);
2121 }
2122 
2123 void menu_handler::request_control_change(int side_num, const std::string& player)
2124 {
2125  std::string side = std::to_string(side_num);
2126  if(board().get_team(side_num).is_local_human() && player == preferences::login()) {
2127  // this is already our side.
2128  return;
2129  } else {
2130  // The server will (or won't because we aren't allowed to change the controller)
2131  // send us a [change_controller] back, which we then handle in playturn.cpp
2132  pc_.send_to_wesnothd(config {"change_controller", config {"side", side, "player", player}});
2133  }
2134 }
2135 
2137 {
2138  for(const std::string& command : utils::split(preferences::custom_command(), ';')) {
2139  do_command(command);
2140  }
2141 }
2142 
2144 {
2145  if(!pc_.is_networked_mp()) {
2146  textbox_info_.show(gui::TEXTBOX_AI, translation::sgettext("prompt^Command:"), "", false, *gui_);
2147  }
2148 }
2149 
2151 {
2152  gui_->get_chat_manager().clear_chat_messages(); // also clear debug-messages and WML-error-messages
2153 }
2154 
2156 {
2157  pc_.send_to_wesnothd(cfg);
2158 }
2159 
2160 } // end namespace events
bool show_theme_dialog()
Definition: display.cpp:65
void label_terrain(mouse_handler &mousehandler, bool team_only)
pathfind::marked_route get_route(const unit *un, map_location go_to, team &team) const
int dispatch(lua_State *L)
int village_owner(const map_location &loc) const
Given the location of a village, will return the 1-based number of the team that currently owns it...
Dialog was closed with the CANCEL button.
Definition: retval.hpp:38
menu_handler & menu_handler_
bool empty() const
Is it empty?
void do_search(const std::string &new_search)
void set_current_paths(const pathfind::paths &new_paths)
virtual replay_controller * get_replay_controller() const
Game board class.
Definition: game_board.hpp:52
static synced_state get_synced_state()
game_data & gamedata()
void show_message(const std::string &title, const std::string &msg, const std::string &button_caption, const bool auto_close, const bool message_use_markup, const bool title_use_markup)
Shows a message to the user.
Definition: message.cpp:153
void set_grid(bool ison)
Definition: general.cpp:567
void add_chat_message(const std::time_t &time, const std::string &speaker, int side, const std::string &message, events::chat_handler::MESSAGE_TYPE type=events::chat_handler::MESSAGE_PRIVATE) override
void goto_leader(int side_num)
std::string format_conjunct_list(const t_string &empty, const std::vector< t_string > &elems)
Format a conjunctive list.
unit_iterator end()
Definition: map.hpp:429
void show_help(const std::string &show_topic, int xloc, int yloc)
Open the help browser, show topic with id show_topic.
Definition: help.cpp:144
bool show_fps()
Definition: general.cpp:892
const team & get_team(int side) const
const unit_type * find(const std::string &key, unit_type::BUILD_STATUS status=unit_type::FULL) const
Finds a unit_type by its id() and makes sure it is built to the specified level.
Definition: types.cpp:1247
void invalidate_game_status()
Function to invalidate the game status displayed on the sidebar.
Definition: display.hpp:300
bool message_private()
Definition: game.cpp:840
std::map< std::string, t_string > string_map
void write_preferences()
Definition: general.cpp:141
void refresh_objectives() const
Reevaluate [show_if] conditions and build a new objectives string.
bool invalidate(const map_location &loc)
Function to invalidate a specific tile for redrawing.
Definition: display.cpp:2972
map_location last_search_hit_
file_dialog & set_extension(const std::string &value)
Sets the default file extension for file names in save mode.
This class represents a single unit of a specific type.
Definition: unit.hpp:120
void show_terrain_description(const terrain_type &t)
Definition: help.cpp:81
const unit_map & get_units() const
Various functions implementing vision (through fog of war and shroud).
void send_chat_message(const std::string &message, bool allies_only=false) override
file_dialog & set_path(const std::string &value)
Sets the initial file selection.
void speak(const config &cfg)
Definition: replay.cpp:351
static manager & get_singleton()
Definition: manager.hpp:145
Various functions that implement attacks and attack calculations.
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:885
map_command_handler< console_handler > chmap
unit_iterator find_leader(int side)
Definition: map.cpp:328
static config get_recall(const std::string &unit_id, const map_location &loc, const map_location &from)
std::vector< std::string > get_commands_list() const
#define a
unit_race::GENDER gender()
Gender choice from the user.
Definition: unit_create.hpp:67
const map_location hovered_hex() const
Uses SDL and game_display::hex_clicked_on to fetch the hex the mouse is hovering, if applicable...
can_move_result unit_can_move(const unit &u) const
Work out what u can do - this does not check which player&#39;s turn is currently active, the result is calculated assuming that the unit&#39;s owner is currently active.
Shows an ok and cancel button.
Definition: message.hpp:76
std::string private_message
const t_string & text() const
Definition: label.hpp:139
menu_handler(game_display *gui, play_controller &pc)
Definition: menu_events.cpp:95
child_itors child_range(config_key_type key)
Definition: config.cpp:344
void show_unit_list(display &gui)
Definition: unit_list.cpp:198
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, const bool restore_background)
Shows a transient message to the user.
void do_command(const std::string &str)
const std::string & choice() const
Unit type choice from the user.
Definition: unit_create.hpp:55
attribute_map::value_type attribute
Definition: config.hpp:221
void redraw_everything()
Invalidates entire screen, including all tiles and sidebar.
Definition: display.cpp:2368
gui::floating_textbox & get_textbox()
General purpose widgets.
void request_control_change(int side_num, const std::string &player)
void invalidate_unit()
Function to invalidate that unit status displayed on the sidebar.
bool show_everything() const
Definition: display.hpp:98
virtual std::string get_cmd() const
int wml_x() const
Definition: location.hpp:153
const unit_type * get_selected_unit_type() const
static config get_auto_shroud(bool turned_on)
Records that the player has toggled automatic shroud updates.
const terrain_type & get_terrain_info(const t_translation::terrain_code &terrain) const
Definition: map.cpp:98
int viewing_side() const
Definition: display.hpp:111
unit_type_data unit_types
Definition: types.cpp:1466
void print(const std::string &title, const std::string &message)
std::size_t move_unit_and_record(const std::vector< map_location > &steps, undo_list *undo_stack, bool continued_move, bool show_move, bool *interrupted, move_unit_spectator *move_spectator)
Moves a unit across the board.
Definition: move.cpp:1232
const std::string & save_id() const
Definition: team.hpp:219
const color_t LABEL_COLOR
file_dialog & set_save_mode(bool value)
Sets the dialog&#39;s behavior on non-existent file name inputs.
bool chars_equal_insensitive(char a, char b)
Definition: general.hpp:23
void update_shroud_now(int side_num)
#define VNGETTEXT(msgid, msgid_plural, count,...)
const gamemap & get_map() const
Replay control code.
#define h
static void msg(const char *act, debug_info &i, const char *to="", const char *result="")
Definition: debugger.cpp:110
bool do_recruit(const std::string &name, int side_num, map_location &target_hex)
virtual void clear_messages() override
Contains the exception interfaces used to signal completion of a scenario, campaign or turn...
static std::string _(const char *str)
Definition: gettext.hpp:93
To lexical_cast(From value)
Lexical cast converts one type to another.
bool show(const unsigned auto_close_time=0)
Shows the window.
void create_unit(mouse_handler &mousehandler)
Creates a unit (in debug mode via hotkey or context menu).
const unit_type_map & types() const
Definition: types.hpp:396
save_id_matches(const std::string &save_id)
bool yellow_confirm()
Definition: game.cpp:960
bool ellipses()
Definition: general.cpp:552
std::vector< unit_const_ptr > get_recalls(int side, const map_location &recall_loc)
Gets the recallable units for a side, restricted by that side&#39;s leaders&#39; personal abilities to recall...
Definition: create.cpp:161
static config get_update_shroud()
Records that the player has manually updated fog/shroud.
static bfs::path get_dir(const bfs::path &dirpath)
Definition: filesystem.cpp:274
void show_statistics(int side_num)
A single unit type that the player may recruit.
Definition: types.hpp:45
void add_chat_message(const std::time_t &time, const std::string &speaker, int side, const std::string &msg, events::chat_handler::MESSAGE_TYPE type, bool bell)
void flush_cache()
Purges all image caches.
Definition: picture.cpp:223
bool get_disallow_recall() const
bool team_valid() const
Definition: display.cpp:722
bool contains(const Container &container, const Value &value)
Returns true iff value is found in container.
Definition: general.hpp:83
int gold() const
Definition: team.hpp:177
void highlight_another_reach(const pathfind::paths &paths_list, const map_location &goal=map_location::null_location())
Add more paths to highlight.
std::string path() const
Gets the current file selection.
bool logged_in_as_moderator()
Gets whether the currently logged-in user is a moderator.
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:27
map_location get_selected_hex() const
game_board & board() const
int action_bonus_count() const
Definition: team.hpp:201
bool confirm_no_moves()
Definition: game.cpp:965
const map_location & get_last_hex() const
const config & options()
Definition: game.cpp:562
std::string write() const
Definition: map.cpp:210
This class stores all the data for a single &#39;side&#39; (in game nomenclature).
Definition: team.hpp:75
bool end_turn(int side_num)
game_display * gui_
console_handler(menu_handler &menu_handler)
virtual void register_alias(const std::string &to_cmd, const std::string &cmd)
void toggle_shroud_updates(int side_num)
team & get_team(int i)
Definition: game_board.hpp:98
void set_custom_command(const std::string &command)
Definition: game.cpp:938
virtual std::string get_arg(unsigned i) const
t_string can_recruit(const std::string &name, int side_num, map_location &target_hex, map_location &recruited_from)
void throw_quit_game_exception()
A simple one-column listbox with OK and Cancel buttons.
const std::vector< unit_race::GENDER > & genders() const
The returned vector will not be empty, provided this has been built to the HELP_INDEXED status...
Definition: types.hpp:251
const std::string & id() const
Gets this unit&#39;s id.
Definition: unit.hpp:370
void scroll_to_leader(int side, SCROLL_TYPE scroll_type=ONSCREEN, bool force=true)
Scrolls to the leader of a certain side.
const t_string & cannot_end_turn_reason()
Definition: game_data.hpp:82
bool hex_hosts_unit(const map_location &hex) const
Unit exists on the hex, no matter if friend or foe.
int cost() const
Definition: types.hpp:175
void disable_units_highlight()
Use this to disable hovering an unit from highlighting its movement range.
std::string label
What to show in the filter&#39;s drop-down list.
Definition: manager.cpp:217
int w() const
Effective map width.
Definition: map.hpp:50
bool is_enabled(const chmap::command &c) const
const std::set< std::string > get_recruits(int side, const map_location &recruit_loc)
Gets the recruitable units from a side&#39;s leaders&#39; personal recruit lists who can recruit on or from a...
Definition: create.cpp:61
This file contains the settings handling of the widget library.
EXIT_STATUS start(const std::string &filename, bool take_screenshot, const std::string &screenshot_filename)
Main interface for launching the editor from the title screen.
Definition: editor_main.cpp:30
const terrain_label * set_label(const map_location &loc, const t_string &text, const int creator=-1, const std::string &team="", const color_t color=font::NORMAL_COLOR, const bool visible_in_fog=true, const bool visible_in_shroud=false, const bool immutable=false, const std::string &category="", const t_string &tooltip="")
Definition: label.cpp:147
void do_create()
Implements the (debug mode) console command that creates a unit.
const t_string & type_name() const
The name of the unit in the current language setting.
Definition: types.hpp:141
Applies the planned unit map for the duration of the struct&#39;s life.
Definition: manager.hpp:252
static bool execute(game_board &board, const int viewing_team, int &selected_side_number)
Definition: game_stats.hpp:39
std::string get_user_data_dir()
Definition: filesystem.cpp:792
void clear(const std::string &, bool force)
Definition: label.cpp:211
int wml_y() const
Definition: location.hpp:154
bool disable_autosave
void write_file(const std::string &fname, const std::string &data)
Throws io_exception if an error occurs.
bool valid() const
Definition: location.hpp:89
const std::unique_ptr< gui::button > & check() const
bool ignore_replay_errors
bool on_board_with_border(const map_location &loc) const
Definition: map.cpp:390
void recall(int side_num, const map_location &last_hex)
void end_unit_turn(mouse_handler &mousehandler, int side_num)
void set_show_fps(bool value)
Definition: general.cpp:897
Encapsulates the map of the game.
Definition: map.hpp:171
std::vector< team > & get_teams()
const t_string & name() const
Gets this unit&#39;s translatable display name.
Definition: unit.hpp:393
virtual const std::set< std::string > & observers() const override
void recruit(int side_num, const map_location &last_hex)
const std::string & last_recruit() const
Definition: team.hpp:216
bool has_friends() const
REMOVE_EMPTY: remove empty elements.
void do_speak(const std::string &message, bool allies_only=false)
bool is_enemy(int n) const
Definition: team.hpp:231
const map_location & get_goto() const
The map location to which this unit is moving over multiple turns, if any.
Definition: unit.hpp:1376
Object which temporarily resets a unit&#39;s movement.
Definition: unit.hpp:1991
std::string path
Definition: game_config.cpp:39
void add_rename(const std::string &name, const map_location &loc)
Definition: replay.cpp:294
Shows a yes and no button.
Definition: message.hpp:80
const std::string & id() const
The id for this unit_type.
Definition: types.hpp:144
Managing the AIs lifecycle - headers TODO: Refactor history handling and internal commands...
replay * recorder
Definition: resources.cpp:29
std::size_t count(const map_location &loc) const
Definition: map.hpp:414
Structure which holds a single route and marks for special events.
Definition: pathfind.hpp:141
bool no_choice() const
Whether the user actually chose a unit type or not.
Definition: unit_create.hpp:61
std::shared_ptr< wb::manager > get_whiteboard() const
const terrain_label * get_label(const map_location &loc, const std::string &team_name) const
Definition: label.hpp:48
const char * what() const noexcept
Definition: exceptions.hpp:36
void invalidate_all()
Function to invalidate all tiles.
Definition: display.cpp:2965
void set_message_private(bool value)
Definition: game.cpp:845
game_events::manager * game_events
Definition: resources.cpp:25
void show_unit_description(const unit &u)
Definition: help.cpp:75
bool fogged(const map_location &loc) const
Returns true if location (x,y) is covered in fog.
Definition: display.cpp:732
const std::string & gender_string(unit_race::GENDER gender)
Definition: race.cpp:142
int recall_cost() const
Definition: team.hpp:181
void flush_cache()
Definition: sound.cpp:195
Encapsulates the map of the game.
Definition: location.hpp:38
bool auto_shroud_updates() const
Definition: team.hpp:326
bool shrouded(const map_location &loc) const
Returns true if location (x,y) is covered in shroud.
Definition: display.cpp:727
Various functions related to moving units.
std::string login()
bool user_end_turn() const
Check whether the user ended their turn.
Definition: unit.hpp:782
unit_iterator find(std::size_t id)
Definition: map.cpp:310
game_state & gamestate() const
Various functions related to the creation of units (recruits, recalls, and placed units)...
actions::undo_list & get_undo_stack()
bool has_moved() const
Checks if this unit has moved.
Definition: unit.hpp:1300
std::string current_team_name() const
void recalculate_labels()
Definition: label.cpp:245
std::string id
Text to match against addon_info.tags()
Definition: manager.cpp:215
virtual bool is_networked_mp() const
void continue_move(mouse_handler &mousehandler, int side_num)
static void print(std::stringstream &sstr, const std::string &queue, const std::string &id)
Definition: fire_event.cpp:30
void add_alias(const std::string &alias, const std::string &command)
Definition: general.cpp:938
std::size_t i
Definition: function.cpp:967
logger & err()
Definition: log.cpp:77
void scroll_to_tile(const map_location &loc, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, bool force=true)
Scroll such that location loc is on-screen.
Definition: display.cpp:2157
bool is_observer() const
Check if we are an observer in this game.
int selected_index() const
Returns the selected item index after displaying.
void execute_gotos(mouse_handler &mousehandler, int side_num)
virtual void highlight_hex(map_location hex) override
Function to highlight a location.
std::string last_search_
Game configuration data as global variables.
Definition: build_info.cpp:60
std::string get_command_flags_description(const chmap::command &c) const
An exception object used when an IO error occurs.
Definition: filesystem.hpp:48
static std::string get_string(typename T::type key)
Uses the int value of the provided enum to get the associated index of the values array in the implem...
Definition: enum_base.hpp:41
void terrain_description(mouse_handler &mousehandler)
Define the game&#39;s event mechanism.
std::string find_recall_location(const int side, map_location &recall_location, map_location &recall_from, const unit &unit_recall)
Finds a location on which to recall unit_recall.
Definition: create.cpp:331
ONLY IF whiteboard is currently active, applies the planned unit map for the duration of the struct&#39;s...
Definition: manager.hpp:273
CURSOR_TYPE get()
Definition: cursor.cpp:216
const display_context & get_disp_context() const
Definition: display.hpp:176
void unit_hold_position(mouse_handler &mousehandler, int side_num)
const std::string & team_name() const
Definition: label.cpp:129
bool on_board(const map_location &loc) const
Tell if a location is on the map.
Definition: map.cpp:385
void change_side(mouse_handler &mousehandler)
game_data gamedata_
Definition: game_state.hpp:46
int w
std::set< std::string > & encountered_units()
Definition: game.cpp:923
static void ignore_error_function(const std::string &message)
A function to be passed to run_in_synced_context to ignore the error.
const bool & debug
Definitions for the terrain builder.
void show(gui::TEXTBOX_MODE mode, const std::string &label, const std::string &check_label, bool checked, game_display &gui)
void set_goto(const map_location &new_goto)
Sets this unit&#39;s long term destination.
Definition: unit.hpp:1382
#define VGETTEXT(msgid,...)
Handy wrappers around interpolate_variables_into_string and gettext.
void set_ellipses(bool ison)
Definition: general.cpp:557
void cycle_units(const bool browse, const bool reverse=false)
void kill_unit(mouse_handler &mousehandler)
play_controller & pc_
Handling of system events.
Definition: manager.hpp:43
bool grid()
Definition: general.cpp:562
bool is_replay() const
bool operator()(const team &t) const
display_chat_manager & get_chat_manager()
static bool run_and_throw(const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function)
bool is_village(const map_location &loc) const
Definition: map.cpp:66
virtual std::string get_data(unsigned n=1) const
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.
bool green_confirm()
Definition: game.cpp:954
bool empty() const
Definition: tstring.hpp:187
game_events::pump_result_t get_village(const map_location &loc, int side, bool *action_timebonus, bool fire_event)
Makes it so the village at the given location is owned by the given side.
Definition: move.cpp:140
const gamemap & get_map() const
Definition: display.hpp:100
To store label data Class implements logic for rendering.
Definition: label.hpp:110
events::mouse_handler & get_mouse_handler_base() override
Get a reference to a mouse handler member a derived class uses.
const std::unique_ptr< gui::textbox > & box() const
unit_map::iterator current_unit()
static std::optional< typename T::type > get_enum(const std::string value)
Convert a string into its enum equivalent.
Definition: enum_base.hpp:52
game_state & gamestate()
double t
Definition: astarsearch.cpp:65
bool unhighlight_reach()
Reset highlighting of paths.
std::vector< std::string > split(const config_attribute_value &val)
void show_enemy_moves(bool ignore_units, int side_num)
const map_location & get_location() const
The current map location this unit is at.
Definition: unit.hpp:1345
static color_t get_side_color(int side)
Definition: team.cpp:960
void set_selected_index(int index)
Sets the initially selected item index (-1 by default).
game_board board_
Definition: game_state.hpp:47
std::size_t viewing_team() const
The viewing team is the team currently viewing the game.
Definition: display.hpp:110
#define DBG_WB
Definition: typedefs.hpp:28
A variable-expanding proxy for the config class.
Definition: variable.hpp:44
Various functions that implement the undoing (and redoing) of in-game commands.
std::string find_recruit_location(const int side, map_location &recruit_location, map_location &recruited_from, const std::string &unit_type)
Finds a location on which to place a unit.
Definition: create.cpp:467
void set_action_bonus_count(const int count)
Definition: team.hpp:202
Standard logging facilities (interface).
static std::string sgettext(const char *str)
Definition: gettext.hpp:62
Object which contains all the possible locations a unit can move to, with associated best routes to t...
Definition: pathfind.hpp:72
recall_list_manager & recall_list()
Definition: team.hpp:203
static const map_location & null_location()
Definition: location.hpp:81
Container associating units to locations.
Definition: map.hpp:98
std::string get_command_flags_description(const map_command_handler< chat_command_handler >::command &c) const
std::string get_flags_description() const
static vconfig empty_vconfig()
Definition: variable.cpp:141
static config get_recruit(const std::string &type_id, const map_location &loc, const map_location &from)
map_labels & labels()
Definition: display.cpp:2482
int turn() const
#define e
retval
Default window/dialog return values.
Definition: retval.hpp:29
int side() const
The side this unit belongs to.
Definition: unit.hpp:333
Definition: help.cpp:57
bool player_acted() const
Returns true if the player has performed any actions this turn.
Definition: undo.hpp:87
Dialog was closed with the OK button.
Definition: retval.hpp:35
gui::floating_textbox textbox_info_
void send_to_server(const config &cfg) override
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:60
void notify_event(const std::string &name, const config &data)
Definition: manager.cpp:145
mock_char c
const std::string & str() const
Definition: tstring.hpp:191
const config & get_alias()
Definition: general.cpp:945
void set_route(const pathfind::marked_route *route)
Sets the route along which footsteps are drawn to show movement of a unit.
Enables auto close.
Definition: message.hpp:70
std::string custom_command()
Definition: game.cpp:933
std::vector< std::string > get_commands_list()
static map_location::DIRECTION n
void repeat_recruit(int side_num, const map_location &last_hex)
int h() const
Effective map height.
Definition: map.hpp:53
void move_unit_to_loc(const unit_map::iterator &ui, const map_location &target, bool continue_move, int side_num, mouse_handler &mousehandler)
Thrown when a lexical_cast fails.
void clear_labels(const std::string &, bool)
Definition: replay.cpp:284
This shows the debug-mode dialog to create new units on the map.
Definition: unit_create.hpp:49
const unsigned int team_num_
int movement_left() const
Gets how far a unit can move, considering the incapacitated flag.
Definition: unit.hpp:1270
unit_map::iterator find_visible_unit(const map_location &loc, const team &current_team, bool see_all=false)
Definition: game_board.cpp:183
virtual void send_to_wesnothd(const config &, const std::string &="unknown") const
Display units performing various actions: moving, attacking, and dying.
std::string variation() const
Variation choice from the user.
Definition: unit_create.hpp:73
virtual void register_command(const std::string &cmd, chat_command_handler::command_handler h, const std::string &help="", const std::string &usage="", const std::string &flags="")
play_controller & pc_
std::vector< map_location > & steps
Definition: pathfind.hpp:187
void set_debug(bool new_debug)
static plugins_manager * get()
Definition: manager.cpp:59
void show_objectives() const
void add_label(const terrain_label *)
Definition: replay.cpp:273
const std::string observer_team_name
observer team name used for observer team chat
Definition: game_config.cpp:91
void do_ai_formula(const std::string &str, int side_num, mouse_handler &mousehandler)
file_dialog & set_title(const std::string &value)
Sets the current dialog title text.
Definition: file_dialog.hpp:57