The Battle for Wesnoth  1.19.0-dev
game_display.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2024
3  by David White <dave@whitevine.net>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 /**
17  * @file
18  * During a game, show map & info-panels at top+right.
19  */
20 
21 #include "game_display.hpp"
22 
23 
24 #include "cursor.hpp"
25 #include "display_chat_manager.hpp"
26 #include "fake_unit_manager.hpp"
27 #include "floating_label.hpp"
28 #include "game_board.hpp"
29 #include "preferences/game.hpp"
30 #include "log.hpp"
31 #include "map/map.hpp"
32 #include "font/standard_colors.hpp"
33 #include "reports.hpp"
34 #include "resources.hpp"
35 #include "tod_manager.hpp"
36 #include "color.hpp"
37 #include "synced_context.hpp"
38 #include "units/unit.hpp"
39 #include "units/drawer.hpp"
40 #include "utils/general.hpp"
41 #include "whiteboard/manager.hpp"
42 #include "overlay.hpp"
43 #include "draw.hpp"
44 
45 static lg::log_domain log_display("display");
46 #define ERR_DP LOG_STREAM(err, log_display)
47 #define LOG_DP LOG_STREAM(info, log_display)
48 #define DBG_DP LOG_STREAM(debug, log_display)
49 
50 static lg::log_domain log_engine("engine");
51 #define ERR_NG LOG_STREAM(err, log_engine)
52 
53 std::map<map_location, int> game_display::debugHighlights_;
54 
55 /**
56  * Function to return 2 half-hex footsteps images for the given location.
57  * Only loc is on the current route set by set_route.
58  *
59  * This function is only used internally by game_display so I have moved it out of the header into the compilaton unit.
60  */
61 std::vector<texture> footsteps_images(const map_location& loc, const pathfind::marked_route & route_, const display_context * dc_);
62 
64  std::weak_ptr<wb::manager> wb,
65  reports& reports_object,
66  const std::string& theme_id,
67  const config& level)
68  : display(&board, wb, reports_object, theme_id, level)
69  , overlay_map_()
70  , attack_indicator_src_()
71  , attack_indicator_dst_()
72  , route_()
73  , displayedUnitHex_()
74  , first_turn_(true)
75  , in_game_(false)
76  , chat_man_(new display_chat_manager(*this))
77  , mode_(RUNNING)
78  , needs_rebuild_(false)
79 {
80 }
81 
83 {
84  try {
85  chat_man_->prune_chat_messages(true);
86  } catch(...) {
87  DBG_DP << "Caught exception in game_display destructor: " << utils::get_unknown_exception_type();
88  }
89 }
90 
92 {
93  if(!first_turn_) {
96 
97  if(old_tod.image_mask != tod.image_mask) {
98  fade_tod_mask(old_tod.image_mask, tod.image_mask);
99  }
100  }
101 
102  first_turn_ = false;
103 
104  update_tod();
105 }
106 
108 {
109  if(hex.valid() && fogged(hex)) {
110  return;
111  }
112  display::select_hex(hex);
113 
114  display_unit_hex(hex);
115 }
116 
118 {
119  wb::future_map_if future(!synced_context::is_synced()); /**< Lasts for whole method. */
120 
122  if (u) {
123  displayedUnitHex_ = hex;
124  invalidate_unit();
125  } else {
127  if (u) {
128  // mouse moved from unit hex to non-unit hex
129  if (dc_->units().count(selectedHex_)) {
131  invalidate_unit();
132  }
133  }
134  }
135 
138 }
139 
140 
142 {
143  if (!hex.valid())
144  return;
145 
146  wb::future_map_if future(!synced_context::is_synced()); /**< Lasts for whole method. */
147 
149  if (u) {
150  displayedUnitHex_ = hex;
151  invalidate_unit();
152  }
153 }
154 
156 {
157  if (src == displayedUnitHex_) {
158  displayedUnitHex_ = dst;
159  invalidate_unit();
160  }
161 }
162 
163 void game_display::scroll_to_leader(int side, SCROLL_TYPE scroll_type,bool force)
164 {
165  unit_map::const_iterator leader = dc_->units().find_leader(side);
166 
167  if(leader.valid() && leader->is_visible_to_team(dc_->get_team(viewing_side()), false)) {
168  scroll_to_tile(leader->get_location(), scroll_type, true, force);
169  }
170 }
171 
173 {
174  display::update();
175 
176  if (std::shared_ptr<wb::manager> w = wb_.lock()) {
177  w->pre_draw();
178  }
180  /**
181  * @todo FIXME: must modify changed, but best to do it at the
182  * floating_label level
183  */
184  chat_man_->prune_chat_messages();
185 }
186 
187 
189 {
190  display::render();
191 
192  if (std::shared_ptr<wb::manager> w = wb_.lock()) {
193  w->post_draw();
194  }
195 }
196 
198 {
200  if (fake_unit_man_->empty()) {
201  return;
202  }
203  unit_drawer drawer = unit_drawer(*this);
204 
205  for (const unit* temp_unit : *fake_unit_man_) {
206  const map_location& loc = temp_unit->get_location();
208  if (invalidated_.find(loc) != invalidated_.end()
209  && (request == exclusive_unit_draw_requests_.end() || request->second == temp_unit->id()))
210  drawer.redraw_unit(*temp_unit);
211  }
212 }
213 
214 namespace
215 {
216 const std::string mouseover_normal_top = "misc/hover-hex-top.png~RC(magenta>gold)";
217 const std::string mouseover_normal_bot = "misc/hover-hex-bottom.png~RC(magenta>gold)";
218 
219 const std::string mouseover_enemy_top = "misc/hover-hex-enemy-top.png~RC(magenta>red)";
220 const std::string mouseover_enemy_bot = "misc/hover-hex-enemy-bottom.png~RC(magenta>red)";
221 
222 const std::string mouseover_self_top = "misc/hover-hex-top.png~RC(magenta>green)";
223 const std::string mouseover_self_bot = "misc/hover-hex-bottom.png~RC(magenta>green)";
224 
225 const std::string mouseover_ally_top = "misc/hover-hex-top.png~RC(magenta>lightblue)";
226 const std::string mouseover_ally_bot = "misc/hover-hex-bottom.png~RC(magenta>lightblue)";
227 }
228 
230 {
231  const bool on_map = get_map().on_board(loc);
232  const bool is_shrouded = shrouded(loc);
233 
234  display::draw_hex(loc);
235 
236  if(cursor::get() == cursor::WAIT) {
237  // Interaction is disabled, so we don't need anything else
238  return;
239  }
240 
241  if(on_map && loc == mouseoverHex_ && !map_screenshot_) {
242  drawing_layer hex_top_layer = LAYER_MOUSEOVER_BOTTOM;
244  if(u != nullptr) {
245  hex_top_layer = LAYER_MOUSEOVER_TOP;
246  }
247 
248  const std::string* mo_top_path;
249  const std::string* mo_bot_path;
250 
251  if(u == nullptr) {
252  mo_top_path = &mouseover_normal_top;
253  mo_bot_path = &mouseover_normal_bot;
254  } else if(dc_->teams()[currentTeam_].is_enemy(u->side())) {
255  mo_top_path = &mouseover_enemy_top;
256  mo_bot_path = &mouseover_enemy_bot;
257  } else if(dc_->teams()[currentTeam_].side() == u->side()) {
258  mo_top_path = &mouseover_self_top;
259  mo_bot_path = &mouseover_self_bot;
260  } else {
261  mo_top_path = &mouseover_ally_top;
262  mo_bot_path = &mouseover_ally_bot;
263  }
264 
265  drawing_buffer_add(hex_top_layer, loc,
266  [tex = image::get_texture(*mo_top_path, image::HEXED)](const rect& dest) { draw::blit(tex, dest); });
267 
269  [tex = image::get_texture(*mo_bot_path, image::HEXED)](const rect& dest) { draw::blit(tex, dest); });
270  }
271 
272  // Draw reach_map information.
273  // We remove the reachability mask of the unit that we want to attack.
274  if(!is_shrouded && !reach_map_.empty() && reach_map_.find(loc) == reach_map_.end() && loc != attack_indicator_dst_) {
277  [tex = image::get_texture(unreachable, image::HEXED)](const rect& dest) { draw::blit(tex, dest); });
278  }
279 
280  if(std::shared_ptr<wb::manager> w = wb_.lock()) {
281  w->draw_hex(loc);
282 
283  if(!(w->is_active() && w->has_temp_move())) {
284  std::vector<texture> footstepImages = footsteps_images(loc, route_, dc_);
285  if(!footstepImages.empty()) {
286  drawing_buffer_add(LAYER_FOOTSTEPS, loc, [images = std::move(footstepImages)](const rect& dest) {
287  for(const texture& t : images) {
288  draw::blit(t, dest);
289  }
290  });
291  }
292  }
293  }
294 
295  // Draw the attack direction indicator
296  if(on_map && loc == attack_indicator_src_) {
298  [tex = image::get_texture("misc/attack-indicator-src-" + attack_indicator_direction() + ".png", image::HEXED)](const rect& dest)
299  { draw::blit(tex, dest); }
300  );
301  } else if(on_map && loc == attack_indicator_dst_) {
303  [tex = image::get_texture("misc/attack-indicator-dst-" + attack_indicator_direction() + ".png", image::HEXED)](const rect& dest)
304  { draw::blit(tex, dest); }
305  );
306  }
307 
308  // Linger overlay unconditionally otherwise it might give glitches
309  // so it's drawn over the shroud and fog.
310  if(mode_ != RUNNING) {
313  [tex = image::get_texture(linger, image::TOD_COLORED)](const rect& dest) { draw::blit(tex, dest); });
314  }
315 
316  if(on_map && loc == selectedHex_ && !game_config::images::selected.empty()) {
319  [tex = image::get_texture(selected, image::HEXED)](const rect& dest) { draw::blit(tex, dest); });
320  }
321 
322  // Show def% and turn to reach info
323  if(!is_shrouded && on_map) {
324  draw_movement_info(loc);
325  }
326 
327  if(game_config::debug) {
328  int debugH = debugHighlights_[loc];
329  if (debugH) {
330  std::string txt = std::to_string(debugH);
332  }
333  }
334 }
335 
337 {
339 }
340 
342 {
344 }
345 
347 {
348  display::layout();
349 
350  if ( !team_valid() )
351  return;
352 
353  refresh_report("report_clock");
354  refresh_report("report_battery");
355  refresh_report("report_countdown");
356 
358  {
359  wb::future_map future; // start planned unit map scope
360 
361  // We display the unit the mouse is over if it is over a unit,
362  // otherwise we display the unit that is selected.
363  for (const std::string &name : reports_object_->report_list()) {
364  refresh_report(name);
365  }
366  invalidateGameStatus_ = false;
367  }
368 }
369 
370 
372 {
373  if(mode != mode_) {
374  mode_ = mode;
375  invalidate_all();
376  }
377 }
378 
380 {
381  // Search if there is a mark here
383 
384  std::shared_ptr<wb::manager> wb = wb_.lock();
385 
386  // Don't use empty route or the first step (the unit will be there)
387  if(w != route_.marks.end()
388  && !route_.steps.empty() && route_.steps.front() != loc) {
389  const unit_map::const_iterator un =
390  (wb && wb->get_temp_move_unit().valid()) ?
391  wb->get_temp_move_unit() : dc_->units().find(route_.steps.front());
392  if(un != dc_->units().end()) {
393  // Display the def% of this terrain
394  int move_cost = un->movement_cost(get_map().get_terrain(loc));
395  int def = (move_cost == movetype::UNREACHABLE ?
396  0 : 100 - un->defense_modifier(get_map().get_terrain(loc)));
397  std::stringstream def_text;
398  def_text << def << "%";
399 
400  color_t color = game_config::red_to_green(def, false);
401 
402  // simple mark (no turn point) use smaller font
403  int def_font = w->second.turns > 0 ? 18 : 16;
404  draw_text_in_hex(loc, LAYER_MOVE_INFO, def_text.str(), def_font, color);
405 
407  [inv = w->second.invisible, zoc = w->second.zoc, cap = w->second.capture](const rect& dest) {
408  if(inv) {
409  draw::blit(image::get_texture(image::locator{"misc/hidden.png"}, image::HEXED), dest);
410  }
411 
412  if(zoc) {
413  draw::blit(image::get_texture(image::locator{"misc/zoc.png"}, image::HEXED), dest);
414  }
415 
416  if(cap) {
417  draw::blit(image::get_texture(image::locator{"misc/capture.png"}, image::HEXED), dest);
418  }
419  });
420 
421  //we display turn info only if different from a simple last "1"
422  if (w->second.turns > 1 || (w->second.turns == 1 && loc != route_.steps.back())) {
423  std::stringstream turns_text;
424  turns_text << w->second.turns;
425  draw_text_in_hex(loc, LAYER_MOVE_INFO, turns_text.str(), 17, font::NORMAL_COLOR, 0.5,0.8);
426  }
427 
428  // The hex is full now, so skip the "show enemy moves"
429  return;
430  }
431  }
432  // When out-of-turn, it's still interesting to check out the terrain defs of the selected unit
433  else if (selectedHex_.valid() && loc == mouseoverHex_)
434  {
435  const unit_map::const_iterator selectedUnit = resources::gameboard->find_visible_unit(selectedHex_,dc_->teams()[currentTeam_]);
436  const unit_map::const_iterator mouseoveredUnit = resources::gameboard->find_visible_unit(mouseoverHex_,dc_->teams()[currentTeam_]);
437  if(selectedUnit != dc_->units().end() && mouseoveredUnit == dc_->units().end()) {
438  // Display the def% of this terrain
439  int move_cost = selectedUnit->movement_cost(get_map().get_terrain(loc));
440  int def = (move_cost == movetype::UNREACHABLE ?
441  0 : 100 - selectedUnit->defense_modifier(get_map().get_terrain(loc)));
442  std::stringstream def_text;
443  def_text << def << "%";
444 
445  color_t color = game_config::red_to_green(def, false);
446 
447  // use small font
448  int def_font = 16;
449  draw_text_in_hex(loc, LAYER_MOVE_INFO, def_text.str(), def_font, color);
450  }
451  }
452 
453  if (!reach_map_.empty()) {
454  reach_map::iterator reach = reach_map_.find(loc);
455  if (reach != reach_map_.end() && reach->second > 1) {
456  const std::string num = std::to_string(reach->second);
457  draw_text_in_hex(loc, LAYER_MOVE_INFO, num, 16, font::YELLOW_COLOR);
458  }
459  }
460 }
461 
462 std::vector<texture> footsteps_images(const map_location& loc, const pathfind::marked_route & route_, const display_context * dc_)
463 {
464  std::vector<texture> res;
465 
466  if (route_.steps.size() < 2) {
467  return res; // no real "route"
468  }
469 
470  std::vector<map_location>::const_iterator i =
471  std::find(route_.steps.begin(),route_.steps.end(),loc);
472 
473  if( i == route_.steps.end()) {
474  return res; // not on the route
475  }
476 
477  // Check which footsteps images of game_config we will use
478  int move_cost = 1;
479  const unit_map::const_iterator u = dc_->units().find(route_.steps.front());
480  if(u != dc_->units().end()) {
481  move_cost = u->movement_cost(dc_->map().get_terrain(loc));
482  }
483  int image_number = std::min<int>(move_cost, game_config::foot_speed_prefix.size());
484  if (image_number < 1) {
485  return res; // Invalid movement cost or no images
486  }
487  const std::string foot_speed_prefix = game_config::foot_speed_prefix[image_number-1];
488 
489  texture teleport;
490 
491  // We draw 2 half-hex (with possibly different directions),
492  // but skip the first for the first step.
493  const int first_half = (i == route_.steps.begin()) ? 1 : 0;
494  // and the second for the last step
495  const int second_half = (i+1 == route_.steps.end()) ? 0 : 1;
496 
497  for (int h = first_half; h <= second_half; ++h) {
498  const std::string sense( h==0 ? "-in" : "-out" );
499 
500  if (!tiles_adjacent(*(i+(h-1)), *(i+h))) {
501  std::string teleport_image =
503  teleport = image::get_texture(teleport_image, image::HEXED);
504  continue;
505  }
506 
507  // In function of the half, use the incoming or outgoing direction
508  map_location::DIRECTION dir = (i+(h-1))->get_relative_dir(*(i+h));
509 
510  std::string rotate;
511  if (dir > map_location::SOUTH_EAST) {
512  // No image, take the opposite direction and do a 180 rotation
513  dir = i->get_opposite_dir(dir);
514  rotate = "~FL(horiz)~FL(vert)";
515  }
516 
517  const std::string image = foot_speed_prefix
518  + sense + "-" + i->write_direction(dir)
519  + ".png" + rotate;
520 
521  res.push_back(image::get_texture(image, image::HEXED));
522  }
523 
524  // we draw teleport image (if any) in last
525  if (teleport != nullptr) res.push_back(teleport);
526 
527  return res;
528 }
529 
530 
531 
533 {
535  highlight_another_reach(paths_list);
536 }
537 
539  const map_location& goal)
540 {
541  // Fold endpoints of routes into reachability map.
542  for (const pathfind::paths::step &dest : paths_list.destinations) {
543  reach_map_[dest.curr]++;
544  }
545  reach_map_changed_ = true;
546 
547  if(goal != map_location::null_location() && paths_list.destinations.contains(goal)) {
548  const auto& path_to_goal = paths_list.destinations.get_path(paths_list.destinations.find(goal));
549  const map_location enemy_unit_location = path_to_goal[0];
550  units_that_can_reach_goal_.insert(enemy_unit_location);
551  }
552 }
553 
555 {
557  if(!reach_map_.empty()) {
558  reach_map_.clear();
559  reach_map_changed_ = true;
560  return true;
561  } else {
562  return false;
563  }
564 }
565 
567 {
568  for(std::vector<map_location>::const_iterator i = route_.steps.begin();
569  i != route_.steps.end(); ++i) {
570  invalidate(*i);
571  }
572 }
573 
575 {
577 
578  if(route != nullptr) {
579  route_ = *route;
580  } else {
581  route_.steps.clear();
582  route_.marks.clear();
583  }
584 
586 }
587 
588 void game_display::float_label(const map_location& loc, const std::string& text, const color_t& color)
589 {
590  if(preferences::show_floating_labels() == false || fogged(loc)) {
591  return;
592  }
593 
594  font::floating_label flabel(text);
596  flabel.set_color(color);
597  flabel.set_position(get_location_x(loc)+zoom_/2, get_location_y(loc));
598  flabel.set_move(0, -0.1 * turbo_speed() * get_zoom_factor());
599  flabel.set_lifetime(1000/turbo_speed());
601 
602  font::add_floating_label(flabel);
603 }
604 
606 {
607  assert(game_config::debug);
608  return debugHighlights_[loc];
609 }
610 
612 {
613  if (attack_indicator_src_ != src || attack_indicator_dst_ != dst) {
616 
617  attack_indicator_src_ = src;
618  attack_indicator_dst_ = dst;
619 
622  }
623 }
624 
626 {
628 }
629 
631 {
632  if (team_valid())
633  {
634  return dc_->teams()[currentTeam_].team_name();
635  }
636  return std::string();
637 }
638 
640 {
641  in_game_ = true;
642  create_buttons();
643  invalidate_all();
644 }
645 
647  if (b) {
648  needs_rebuild_ = true;
649  }
650 }
651 
653  if (needs_rebuild_) {
654  needs_rebuild_ = false;
656  invalidate_all();
657  rebuild_all();
658  return true;
659  }
660  return false;
661 }
662 
664 {
665  return overlay_map_;
666 }
const std::vector< map_location > & route_
Definition: move.cpp:294
double t
Definition: astarsearch.cpp:63
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
Abstract class for exposing game data that doesn't depend on the GUI, however which for historical re...
const team & get_team(int side) const
This getter takes a 1-based side number, not a 0-based team number.
virtual const gamemap & map() const =0
virtual const std::vector< team > & teams() const =0
virtual const unit_map & units() const =0
Sort-of-Singleton that many classes, both GUI and non-GUI, use to access the game data.
Definition: display.hpp:81
bool map_screenshot_
Used to indicate to drawing functions that we are doing a map screenshot.
Definition: display.hpp:926
void draw_text_in_hex(const map_location &loc, const drawing_layer layer, const std::string &text, std::size_t font_size, color_t color, double x_in_hex=0.5, double y_in_hex=0.5)
Draw text on a hex.
Definition: display.cpp:1476
int viewing_side() const
The 1-based equivalent of the 0-based viewing_team() function.
Definition: display.hpp:124
std::map< map_location, std::vector< overlay > > overlay_map
Definition: display.hpp:946
map_location selectedHex_
Definition: display.hpp:774
std::size_t viewing_team() const
The viewing team is the team currently viewing the game.
Definition: display.hpp:116
void recalculate_minimap()
Schedule the minimap for recalculation.
Definition: display.cpp:1652
virtual void render() override
Update offscreen render buffers.
Definition: display.cpp:2473
void fade_tod_mask(const std::string &old, const std::string &new_)
ToD mask smooth fade.
Definition: display.cpp:2259
bool invalidate(const map_location &loc)
Function to invalidate a specific tile for redrawing.
Definition: display.cpp:3137
drawing_layer
The layers to render something on.
Definition: display.hpp:802
@ LAYER_MOUSEOVER_BOTTOM
Bottom half of image following the mouse.
Definition: display.hpp:830
@ LAYER_ATTACK_INDICATOR
Layer which holds the attack indicator.
Definition: display.hpp:835
@ LAYER_MOVE_INFO
Movement info (defense%, etc...).
Definition: display.hpp:840
@ LAYER_FOOTSTEPS
Footsteps showing path from unit to mouse.
Definition: display.hpp:809
@ LAYER_LINGER_OVERLAY
The overlay used for the linger mode.
Definition: display.hpp:841
@ LAYER_SELECTED_HEX
Image on the selected unit.
Definition: display.hpp:834
@ LAYER_REACHMAP
"black stripes" on unreachable hexes.
Definition: display.hpp:829
@ LAYER_MOUSEOVER_TOP
Top half of image following the mouse.
Definition: display.hpp:810
double turbo_speed() const
Definition: display.cpp:2230
bool reach_map_changed_
Definition: display.hpp:943
int get_location_x(const map_location &loc) const
Functions to get the on-screen positions of hexes.
Definition: display.cpp:707
static double get_zoom_factor()
Returns the current zoom factor.
Definition: display.hpp:261
void invalidate_game_status()
Function to invalidate the game status displayed on the sidebar.
Definition: display.hpp:307
void rebuild_all()
Rebuild all dynamic terrain.
Definition: display.cpp:452
virtual void layout() override
Finalize screen layout.
Definition: display.cpp:2442
virtual void highlight_hex(map_location hex)
Definition: display.cpp:1554
void update_tod(const time_of_day *tod_override=nullptr)
Applies r,g,b coloring to the map.
Definition: display.cpp:405
void process_reachmap_changes()
Definition: display.cpp:3309
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:2067
map_location mouseoverHex_
Definition: display.hpp:775
bool fogged(const map_location &loc) const
Returns true if location (x,y) is covered in fog.
Definition: display.cpp:702
const gamemap & get_map() const
Definition: display.hpp:99
void invalidate_all()
Function to invalidate all tiles.
Definition: display.cpp:3130
void drawing_buffer_add(const drawing_layer layer, const map_location &loc, decltype(draw_helper::do_draw) draw_func)
Add an item to the drawing buffer.
Definition: display.cpp:1287
exclusive_unit_draw_requests_t exclusive_unit_draw_requests_
map of hexes where only one unit should be drawn, the one identified by the associated id string
Definition: display.hpp:682
bool team_valid() const
Definition: display.cpp:692
std::set< map_location > invalidated_
Definition: display.hpp:764
void create_buttons()
Definition: display.cpp:875
bool invalidateGameStatus_
Definition: display.hpp:745
virtual void draw_invalidated()
Only called when there's actual redrawing to do.
Definition: display.cpp:2630
reports * reports_object_
Definition: display.hpp:747
virtual void update() override
Update animations and internal state.
Definition: display.cpp:2425
int get_location_y(const map_location &loc) const
Definition: display.cpp:712
virtual void draw_hex(const map_location &loc)
Redraws a single gamemap location.
Definition: display.cpp:2671
std::size_t currentTeam_
Definition: display.hpp:719
const std::unique_ptr< fake_unit_manager > fake_unit_man_
Definition: display.hpp:738
const display_context * dc_
Definition: display.hpp:676
static unsigned int zoom_
The current zoom, in pixels (on screen) per 72 pixels (in the graphic assets), i.e....
Definition: display.hpp:734
bool shrouded(const map_location &loc) const
Returns true if location (x,y) is covered in shroud.
Definition: display.cpp:697
bool dont_show_all_
Definition: display.hpp:720
void refresh_report(const std::string &report_name, const config *new_cfg=nullptr)
Update the given report.
Definition: display.cpp:2886
std::weak_ptr< wb::manager > wb_
Definition: display.hpp:678
virtual void select_hex(map_location hex)
Definition: display.cpp:1546
reach_map reach_map_
Definition: display.hpp:941
void set_move(double xmove, double ymove)
void set_lifetime(int lifetime, int fadeout=100)
void set_position(double xpos, double ypos)
void set_color(const color_t &color)
void set_scroll_mode(LABEL_SCROLL_MODE scroll)
void set_font_size(int font_size)
Game board class.
Definition: game_board.hpp:46
unit_map::iterator find_visible_unit(const map_location &loc, const team &current_team, bool see_all=false)
Definition: game_board.cpp:185
unit * get_visible_unit(const map_location &loc, const team &current_team, bool see_all=false)
Definition: game_board.cpp:213
std::string current_team_name() const
virtual void draw_invalidated() override
Only called when there's actual redrawing to do.
void draw_movement_info(const map_location &loc)
Draws the movement info (turns available) for a given location.
void display_unit_hex(map_location hex)
Change the unit to be displayed in the sidebar.
void invalidate_unit_after_move(const map_location &src, const map_location &dst)
Same as invalidate_unit() if moving the displayed unit.
std::string attack_indicator_direction() const
Function to get attack direction suffix.
game_mode mode_
virtual void highlight_hex(map_location hex) override
Function to highlight a location.
map_location displayedUnitHex_
void invalidate_route()
void scroll_to_leader(int side, SCROLL_TYPE scroll_type=ONSCREEN, bool force=true)
Scrolls to the leader of a certain side.
void set_game_mode(const game_mode mode)
virtual void draw_hex(const map_location &loc) override
Redraws a single gamemap location.
static std::map< map_location, int > debugHighlights_
void set_attack_indicator(const map_location &src, const map_location &dst)
Set the attack direction indicator.
static int & debug_highlight(const map_location &loc)
annotate hex with number, useful for debugging or UI prototype
const std::unique_ptr< display_chat_manager > chat_man_
pathfind::marked_route route_
virtual void render() override
TLD render() override.
void set_route(const pathfind::marked_route *route)
Sets the route along which footsteps are drawn to show movement of a unit.
virtual overlay_map & get_overlays() override
Inherited from display.
std::set< map_location > units_that_can_reach_goal_
void invalidate_unit()
Function to invalidate that unit status displayed on the sidebar.
virtual void select_hex(map_location hex) override
Function to display a location as selected.
void highlight_reach(const pathfind::paths &paths_list)
Sets the paths that are currently displayed as available for the unit to move along.
void new_turn()
Update lighting settings.
void clear_attack_indicator()
virtual const time_of_day & get_time_of_day(const map_location &loc) const override
void highlight_another_reach(const pathfind::paths &paths_list, const map_location &goal=map_location::null_location())
Add more paths to highlight.
map_location attack_indicator_dst_
game_mode
Sets the linger mode for the display.
@ RUNNING
no linger overlay, show fog and shroud.
bool unhighlight_reach()
Reset highlighting of paths.
void needs_rebuild(bool b)
Sets whether the screen (map visuals) needs to be rebuilt.
overlay_map overlay_map_
bool maybe_rebuild()
Rebuilds the screen if needs_rebuild(true) was previously called, and resets the flag.
virtual void layout() override
TLD layout() override.
virtual bool has_time_area() const override
game_display(game_board &board, std::weak_ptr< wb::manager > wb, reports &reports_object, const std::string &theme_id, const config &level)
virtual void update() override
TLD update() override.
map_location attack_indicator_src_
void float_label(const map_location &loc, const std::string &text, const color_t &color)
Function to float a label above a tile.
terrain_code get_terrain(const map_location &loc) const
Looks up terrain at a particular location.
Definition: map.cpp:301
bool on_board(const map_location &loc) const
Tell if a location is on the map.
Definition: map.cpp:384
Generic locator abstracting the location of an image.
Definition: picture.hpp:63
static const int UNREACHABLE
Magic value that signifies a hex is unreachable.
Definition: movetype.hpp:175
const std::set< std::string > & report_list()
Definition: reports.cpp:1814
static bool is_synced()
Wrapper class to encapsulate creation and management of an SDL_Texture.
Definition: texture.hpp:33
bool has_time_area() const
const time_of_day & get_time_of_day(int for_turn=0) const
Returns global time of day for the passed turn.
Definition: tod_manager.hpp:56
const time_of_day & get_previous_time_of_day() const
void redraw_unit(const unit &u) const
draw a unit.
Definition: drawer.cpp:166
unit_iterator end()
Definition: map.hpp:428
std::size_t count(const map_location &loc) const
Definition: map.hpp:413
unit_iterator find(std::size_t id)
Definition: map.cpp:302
unit_iterator find_leader(int side)
Definition: map.cpp:320
This class represents a single unit of a specific type.
Definition: unit.hpp:133
Drawing functions, for drawing things on the screen.
std::size_t i
Definition: function.cpp:968
int w
static lg::log_domain log_engine("engine")
std::vector< texture > footsteps_images(const map_location &loc, const pathfind::marked_route &route_, const display_context *dc_)
Function to return 2 half-hex footsteps images for the given location.
static lg::log_domain log_display("display")
#define DBG_DP
int side() const
The side this unit belongs to.
Definition: unit.hpp:343
bool tiles_adjacent(const map_location &a, const map_location &b)
Function which tells if two locations are adjacent.
Definition: location.cpp:502
Standard logging facilities (interface).
bool is_shrouded(const display *disp, const map_location &loc)
Our definition of map labels being obscured is if the tile is obscured, or the tile below is obscured...
Definition: label.cpp:32
CURSOR_TYPE get()
Definition: cursor.cpp:216
@ WAIT
Definition: cursor.hpp:28
void blit(const texture &tex, const SDL_Rect &dst)
Draws a texture, or part of a texture, at the given location.
Definition: draw.cpp:310
const int SIZE_FLOAT_LABEL
Definition: constants.cpp:32
const color_t YELLOW_COLOR
int add_floating_label(const floating_label &flabel)
add a label floating on the screen above everything else.
const color_t BAD_COLOR
const color_t NORMAL_COLOR
@ ANCHOR_LABEL_MAP
std::string selected
std::string unreachable
std::string foot_teleport_enter
std::vector< std::string > foot_speed_prefix
std::string foot_teleport_exit
const bool & debug
Definition: game_config.cpp:91
color_t red_to_green(double val, bool for_text)
Return a color corresponding to the value val red for val=0.0 to green for val=100....
Functions to load and save images from/to disk.
@ HEXED
Standard hexagonal tile mask applied, removing portions that don't fit.
Definition: picture.hpp:228
@ TOD_COLORED
Same as HEXED, but with Time of Day color tint applied.
Definition: picture.hpp:230
texture get_texture(const image::locator &i_locator, TYPE type, bool skip_cache)
Returns an image texture suitable for hardware-accelerated rendering.
Definition: picture.cpp:959
bool show_floating_labels()
Definition: game.cpp:820
Unit and team statistics.
::tod_manager * tod_manager
Definition: resources.cpp:29
game_board * gameboard
Definition: resources.cpp:20
std::size_t size(const std::string &str)
Length in characters of a UTF-8 string.
Definition: unicode.cpp:85
std::string get_unknown_exception_type()
Utility function for finding the type of thing caught with catch(...).
Definition: general.cpp:23
Definition: display.hpp:45
std::string::const_iterator iterator
Definition: tokenizer.hpp:25
The basic class for representing 8-bit RGB or RGBA colour values.
Definition: color.hpp:59
Encapsulates the map of the game.
Definition: location.hpp:38
DIRECTION
Valid directions which can be moved in our hexagonal world.
Definition: location.hpp:40
bool valid() const
Definition: location.hpp:89
static const map_location & null_location()
Definition: location.hpp:81
Structure which holds a single route and marks for special events.
Definition: pathfind.hpp:142
std::vector< map_location > & steps
Definition: pathfind.hpp:187
std::vector< map_location > get_path(const const_iterator &) const
Returns the path going from the source point (included) to the destination point j (excluded).
Definition: pathfind.cpp:497
bool contains(const map_location &) const
Definition: pathfind.cpp:514
const_iterator find(const map_location &) const
Definition: pathfind.cpp:478
map_location curr
Definition: pathfind.hpp:89
Object which contains all the possible locations a unit can move to, with associated best routes to t...
Definition: pathfind.hpp:73
dest_vect destinations
Definition: pathfind.hpp:101
An abstract description of a rectangle with integer coordinates.
Definition: rect.hpp:47
Object which defines a time of day with associated bonuses, image, sounds etc.
Definition: time_of_day.hpp:57
std::string image_mask
The image that is to be laid over all images while this time of day lasts.
Definition: time_of_day.hpp:96
bool valid() const
Definition: map.hpp:273
Applies the planned unit map for the duration of the struct's life.
Definition: manager.hpp:253
#define h
#define b