The Battle for Wesnoth  1.19.3+dev
play_controller.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2006 - 2024
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 #pragma once
18 
19 #include "controller_base.hpp"
20 #include "game_end_exceptions.hpp"
21 #include "help/help.hpp"
23 #include "menu_events.hpp"
24 #include "mouse_events.hpp"
25 #include "persist_manager.hpp"
26 #include "tod_manager.hpp"
27 #include "game_state.hpp"
28 #include "utils/optional_fwd.hpp"
29 
30 #include <set>
31 
32 class team;
33 class replay;
34 class replay_controller;
35 class saved_game;
36 struct mp_game_settings;
39 
40 namespace actions {
41  class undo_list;
42 }
43 
44 namespace font {
45  struct floating_label_context;
46 }
47 
48 namespace game_events {
49  class wml_event_pump;
50 } // namespace game_events
51 
52 class statistics_t;
53 
54 namespace wb {
55  class manager; // whiteboard manager
56 } // namespace wb
57 
58 // Holds gamestate related objects
59 
61 {
62 public:
64  saved_game& state_of_game);
65  virtual ~play_controller();
66 
67  //event handler, overridden from observer
68  //there is nothing to handle in this class actually but that might change in the future
69  virtual void handle_generic_event(const std::string& /*name*/) override {}
70 
71  bool can_undo() const;
72  bool can_redo() const;
73 
74  void undo();
75  void redo();
76 
77  void load_game();
78 
79  void save_game();
80  void save_game_auto(const std::string& filename);
81  void save_replay();
82  void save_replay_auto(const std::string& filename);
83  void save_map();
84  replay& get_replay();
85 
86  void init_side_begin();
87 
88  /**
89  * Called by turn_info::process_network_data() or init_side() to call do_init_side() if necessary.
90  */
91  void maybe_do_init_side();
92 
93  /**
94  * Called by replay handler or init_side() to do actual work for turn change.
95  */
96  void do_init_side();
97 
98  void init_side_end();
99 
100  virtual void force_end_turn() = 0;
101  virtual void check_objectives() = 0;
102 
103  virtual void on_not_observer() = 0;
104 
105  /**
106  * Asks the user whether to continue on an OOS error.
107  *
108  * @throw quit_game_exception If the user wants to abort.
109  */
110  virtual void process_oos(const std::string& msg) const;
111 
112  bool reveal_map_default() const;
113 
115  {
117  }
118 
120  {
121  gamestate().end_level_data_.reset();
122  }
123 
124  bool is_regular_game_end() const
125  {
126  return gamestate().end_level_data_.has_value();
127  }
128 
130  {
131  return *gamestate().end_level_data_;
132  }
133 
134  std::vector<team>& get_teams()
135  {
136  return gamestate().board_.teams();
137  }
138 
139  const std::vector<team>& get_teams() const
140  {
141  return gamestate().board_.teams();
142  }
143 
144  const unit_map& get_units() const
145  {
146  return gamestate().board_.units();
147  }
148 
150  {
151  return gamestate().board_.units();
152  }
153 
154  const gamemap& get_map() const
155  {
156  return gamestate().board_.map();
157  }
158 
160  {
161  return gamestate().tod_manager_;
162  }
163 
164  bool is_observer() const
165  {
166  return gamestate().board_.is_observer();
167  }
168 
169  bool do_healing() const
170  {
171  return gamestate().do_healing_;
172  }
173 
175  {
177  }
178 
180  {
181  return *gamestate_;
182  }
183 
184  const game_state& gamestate() const
185  {
186  return *gamestate_;
187  }
188 
189  /**
190  * Checks to see if a side has won.
191  *
192  * This will also remove control of villages from sides with dead leaders.
193  */
194  void check_victory();
195 
196  std::size_t turn() const {return gamestate().tod_manager_.turn();}
197 
198  /**
199  * Returns the number of the side whose turn it is.
200  *
201  * Numbering starts at one.
202  */
203  int current_side() const { return gamestate_->player_number_; }
204 
205  /**
206  * Builds the snapshot config from members and their respective configs.
207  */
208  config to_config() const;
209 
210  bool is_skipping_replay() const { return skip_replay_; }
211  void toggle_skipping_replay();
212  void do_autosave();
213 
214  bool is_skipping_story() const { return skip_story_; }
215 
216  void do_consolesave(const std::string& filename);
217 
220 
221  std::shared_ptr<wb::manager> get_whiteboard() const;
226 
228 
229  virtual soundsource::manager* get_soundsource_man() override;
230  virtual plugins_context* get_plugins_context() override;
232 
234 
235  bool is_browsing() const override;
236 
237  class hotkey_handler;
238 
239  virtual replay_controller * get_replay_controller() const { return nullptr; }
240  bool is_replay() const { return get_replay_controller() != nullptr; }
241 
242  replay& recorder() const { return *replay_; }
243 
245  {
246  return level_["name"].t_str();
247  }
248 
249  bool get_disallow_recall() const
250  {
251  return level_["disallow_recall"].to_bool();
252  }
253 
254  std::string get_loaded_resources() const
255  {
256  return level_["loaded_resources"].str();
257  }
258 
259  std::string theme() const
260  {
261  return gamestate_->get_game_data()->get_theme();
262  }
263 
264  virtual bool should_return_to_play_side() const
265  {
266  return is_regular_game_end();
267  }
268 
269  void maybe_throw_return_to_play_side() const;
270 
271  team& current_team();
272  const team& current_team() const;
273 
274  bool can_use_synced_wml_menu() const;
275  std::set<std::string> all_players() const;
276  int ticks() const { return ticks_; }
277  game_display& get_display() override;
278 
279  void update_savegame_snapshot() const;
280  /**
281  * Changes the UI for this client to the passed side index.
282  */
283  void update_gui_to_player(const int team_index, const bool observe = false);
284 
285  /// Sends replay [command]s to the server
286  virtual void send_actions() { }
287  /// Reads and executes replay [command]s from the server
288  virtual void receive_actions() { }
289 
290  virtual bool is_networked_mp() const { return false; }
291  virtual void send_to_wesnothd(const config&, const std::string& = "unknown") const { }
292  virtual bool receive_from_wesnothd(config&) const { return false; }
293  /** Reevaluate [show_if] conditions and build a new objectives string. */
294  void refresh_objectives() const;
295  void show_objectives() const;
296 
298  {
302  };
303 
305 
307  bool is_during_turn() const;
308  bool is_linger_mode() const;
309 
310 protected:
312  void play_slice_catch();
313  bool have_keyboard_focus() override;
314  void process_focus_keydown_event(const SDL_Event& event) override;
315  void process_keydown_event(const SDL_Event& event) override;
316  void process_keyup_event(const SDL_Event& event) override;
317 
318  void init_managers();
319  /** preload events cannot be synced */
320  void fire_preload();
321  void fire_prestart();
322  void fire_start();
323  void start_game();
324  virtual void init_gui();
326  void finish_turn(); //this should not throw an end turn or end level exception
327  bool enemies_visible() const;
328 
329  void enter_textbox();
330  void textbox_move_vertically(bool up);
331  void tab();
332 
333 public:
334  /** returns 0 if no such team was found. */
335  virtual int find_viewing_side() const = 0;
336 private:
337  const int ticks_;
338 
339 protected:
340  //gamestate
341  std::unique_ptr<game_state> gamestate_;
344 
345  //managers
347 
348  //whiteboard manager
349  std::shared_ptr<wb::manager> whiteboard_manager_;
350 
351  //plugins context
352  std::unique_ptr<plugins_context> plugins_context_;
353 
354  //more managers
355  std::unique_ptr<font::floating_label_context> labels_manager_;
359  std::unique_ptr<hotkey_handler> hotkey_handler_;
360  std::unique_ptr<soundsource::manager> soundsources_manager_;
362 
363  //other objects
364  std::unique_ptr<game_display> gui_;
365  const std::unique_ptr<unit_experience_accelerator> xp_mod_;
366  const std::unique_ptr<statistics_t> statistics_context_;
368  const actions::undo_list& undo_stack() const { return *gamestate().undo_stack_; }
369  std::unique_ptr<replay> replay_;
370 
373  /**
374  * Whether we did init sides in this session
375  * (false = we did init sides before we reloaded the game).
376  */
379  //the displayed location when we load a game.
381  // Whether to start with the display faded to black
383 
384  const std::string& select_music(bool victory) const;
385 
386  void reset_gamestate(const config& level, int replay_pos);
387 
388 private:
389 
390  void init(const config& level);
391 
392  /**
393  * This shows a warning dialog if either [scenario]next_scenario or any [endlevel]next_scenario would lead to an "Unknown Scenario" dialog.
394  */
396 
397  std::vector<std::string> victory_music_;
398  std::vector<std::string> defeat_music_;
399 
401 
402 protected:
403  mutable bool ignore_replay_errors_;
404  /// true when the controller of the currently playing side has changed.
405  /// this can mean for example:
406  /// - The currently active side was reassigned from/to another player in a mp game
407  /// - The replay controller was disabled ('continue play' button)
408  /// - The currently active side was droided / undroided.
409  /// - A side was set to idle.
411  virtual void sync_end_turn() {}
412  virtual void check_time_over();
413  virtual void update_viewing_player() = 0;
414 };
Class to store the actions that a player can undo and redo.
Definition: undo.hpp:34
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
bool is_observer() const
Check if we are an observer in this game.
virtual const std::vector< team > & teams() const override
Definition: game_board.hpp:80
virtual const unit_map & units() const override
Definition: game_board.hpp:107
virtual const gamemap & map() const override
Definition: game_board.hpp:97
utils::optional< end_level_data > end_level_data_
Definition: game_state.hpp:64
int server_request_number_
Definition: game_state.hpp:66
const std::unique_ptr< actions::undo_list > undo_stack_
undo_stack_ is never nullptr.
Definition: game_state.hpp:56
bool do_healing_
True if healing should be done at the beginning of the next side turn.
Definition: game_state.hpp:60
game_board board_
Definition: game_state.hpp:44
tod_manager tod_manager_
Definition: game_state.hpp:45
Encapsulates the map of the game.
Definition: map.hpp:172
unit_map & get_units()
game_classification & get_classification()
const std::string & select_music(bool victory) const
virtual void handle_generic_event(const std::string &) override
void process_keydown_event(const SDL_Event &event) override
Process keydown (always).
events::menu_handler & get_menu_handler()
void maybe_throw_return_to_play_side() const
config to_config() const
Builds the snapshot config from members and their respective configs.
virtual void on_not_observer()=0
void init(const config &level)
const std::vector< team > & get_teams() const
virtual bool receive_from_wesnothd(config &) const
int get_server_request_number() const
std::vector< team > & get_teams()
std::unique_ptr< hotkey_handler > hotkey_handler_
virtual void init_gui()
virtual replay_controller * get_replay_controller() const
bool have_keyboard_focus() override
Derived classes should override this to return false when arrow keys should not scroll the map,...
std::unique_ptr< game_state > gamestate_
void show_objectives() const
events::menu_handler menu_handler_
void fire_preload()
preload events cannot be synced
std::vector< std::string > victory_music_
void check_victory()
Checks to see if a side has won.
bool is_linger_mode() const
actions::undo_list & undo_stack()
statistics_t & statistics()
virtual soundsource::manager * get_soundsource_man() override
Get (optionally) a soundsources manager a derived class uses.
void check_next_scenario_is_known()
This shows a warning dialog if either [scenario]next_scenario or any [endlevel]next_scenario would le...
bool reveal_map_default() const
actions::undo_list & get_undo_stack()
const unit_map & get_units() const
play_controller(const config &level, saved_game &state_of_game)
bool do_healing() const
void set_end_level_data(const end_level_data &data)
events::mouse_handler & get_mouse_handler_base() override
Get a reference to a mouse handler member a derived class uses.
void update_savegame_snapshot() const
virtual int find_viewing_side() const =0
returns 0 if no such team was found.
void increase_server_request_number()
bool is_observer() const
void set_do_healing(bool do_healing)
const actions::undo_list & undo_stack() const
bool is_during_turn() const
bool can_use_synced_wml_menu() const
void reset_gamestate(const config &level, int replay_pos)
bool is_skipping_story() const
void do_consolesave(const std::string &filename)
void save_game_auto(const std::string &filename)
void textbox_move_vertically(bool up)
bool is_regular_game_end() const
saved_game & get_saved_game()
tooltips::manager tooltips_manager_
virtual void check_objectives()=0
void save_replay_auto(const std::string &filename)
saved_game & saved_game_
game_state & gamestate()
hotkey::command_executor * get_hotkey_command_executor() override
Optionally get a command executor to handle context menu events.
bool enemies_visible() const
std::unique_ptr< replay > replay_
const std::unique_ptr< statistics_t > statistics_context_
const mp_game_settings & get_mp_settings()
game_display & get_display() override
Get a reference to a display member a derived class uses.
virtual void update_viewing_player()=0
virtual void sync_end_turn()
std::unique_ptr< game_display > gui_
void maybe_do_init_side()
Called by turn_info::process_network_data() or init_side() to call do_init_side() if necessary.
virtual void process_oos(const std::string &msg) const
Asks the user whether to continue on an OOS error.
bool is_browsing() const override
virtual void send_to_wesnothd(const config &, const std::string &="unknown") const
std::unique_ptr< soundsource::manager > soundsources_manager_
const end_level_data & get_end_level_data() const
void do_init_side()
Called by replay handler or init_side() to do actual work for turn change.
std::string theme() const
const tod_manager & get_tod_manager() const
int current_side() const
Returns the number of the side whose turn it is.
virtual bool is_networked_mp() const
bool is_skipping_replay() const
bool get_disallow_recall() const
const hotkey::scope_changer scope_
std::unique_ptr< font::floating_label_context > labels_manager_
std::shared_ptr< wb::manager > get_whiteboard() const
std::vector< std::string > defeat_music_
const gamemap & get_map() const
bool did_autosave_this_turn_
Whether we did init sides in this session (false = we did init sides before we reloaded the game).
bool is_replay() const
bool player_type_changed_
true when the controller of the currently playing side has changed.
std::size_t turn() const
map_location map_start_
virtual bool should_return_to_play_side() const
std::set< std::string > all_players() const
virtual void force_end_turn()=0
void update_gui_to_player(const int team_index, const bool observe=false)
Changes the UI for this client to the passed side index.
events::mouse_handler mouse_handler_
std::unique_ptr< plugins_context > plugins_context_
virtual plugins_context * get_plugins_context() override
Get (optionally) a plugins context a derived class uses.
virtual ~play_controller()
bool can_undo() const
const std::unique_ptr< unit_experience_accelerator > xp_mod_
void process_focus_keydown_event(const SDL_Event &event) override
Process keydown (only when the general map display does not have focus).
virtual void send_actions()
Sends replay [command]s to the server.
void refresh_objectives() const
Reevaluate [show_if] conditions and build a new objectives string.
bool can_redo() const
game_events::wml_event_pump & pump()
void process_keyup_event(const SDL_Event &event) override
Process keyup (always).
void finish_side_turn_events()
replay & recorder() const
std::string get_loaded_resources() const
help::help_manager help_manager_
const game_state & gamestate() const
persist_manager persist_
virtual void receive_actions()
Reads and executes replay [command]s from the server.
std::shared_ptr< wb::manager > whiteboard_manager_
virtual void check_time_over()
t_string get_scenario_name() const
Implements a quit confirmation dialog.
This class stores all the data for a single 'side' (in game nomenclature).
Definition: team.hpp:74
int turn() const
Container associating units to locations.
Definition: map.hpp:98
controller_base framework: controller_base is roughly analogous to a "dialog" class in a GUI toolkit ...
Contains the exception interfaces used to signal completion of a scenario, campaign or turn.
Collection of helper functions relating to Pango formatting.
Domain specific events.
Definition: display.hpp:45
static void msg(const char *act, debug_info &i, const char *to="", const char *result="")
Definition: debugger.cpp:109
std::string_view data
Definition: picture.cpp:178
std::string filename
Filename.
Additional information on the game outcome which can be provided by WML.
The help implementation caches data parsed from the game_config.
Definition: help.hpp:39
Encapsulates the map of the game.
Definition: location.hpp:38
scoped_savegame_snapshot(const play_controller &controller)