#include <game_display.hpp>

Inheritance diagram for game_display:

Public Types
enum	game_mode { RUNNING , LINGER }
	Sets the linger mode for the display. More...

Public Types inherited from display
enum	SCROLL_TYPE { SCROLL , WARP , ONSCREEN , ONSCREEN_WARP }

enum	drawing_layer { LAYER_TERRAIN_BG , LAYER_GRID_TOP , LAYER_MOUSEOVER_OVERLAY , LAYER_FOOTSTEPS , LAYER_MOUSEOVER_TOP , LAYER_UNIT_FIRST , LAYER_UNIT_BG = LAYER_UNIT_FIRST+10 , LAYER_UNIT_DEFAULT =LAYER_UNIT_FIRST+40 , LAYER_TERRAIN_FG = LAYER_UNIT_FIRST+50 , LAYER_GRID_BOTTOM , LAYER_UNIT_MOVE_DEFAULT =LAYER_UNIT_FIRST+60 , LAYER_UNIT_FG = LAYER_UNIT_FIRST+80 , LAYER_UNIT_MISSILE_DEFAULT = LAYER_UNIT_FIRST+90 , LAYER_UNIT_LAST =LAYER_UNIT_FIRST+100 , LAYER_REACHMAP , LAYER_MOUSEOVER_BOTTOM , LAYER_FOG_SHROUD , LAYER_ARROWS , LAYER_ACTIONS_NUMBERING , LAYER_SELECTED_HEX , LAYER_ATTACK_INDICATOR , LAYER_UNIT_BAR , LAYER_MOVE_INFO , LAYER_LINGER_OVERLAY , LAYER_BORDER }
	The layers to render something on. More...

enum	DEBUG_FLAG { DEBUG_COORDINATES , DEBUG_TERRAIN_CODES , DEBUG_NUM_BITMAPS , DEBUG_FOREGROUND , DEBUG_BENCHMARK , __NUM_DEBUG_FLAGS }

Public Member Functions
	game_display (game_board &board, std::weak_ptr< wb::manager > wb, reports &reports_object, const std::string &theme_id, const config &level)

	~game_display ()

void	new_turn ()
	Update lighting settings. More...

virtual const std::set< std::string > &	observers () const override

void	scroll_to_leader (int side, SCROLL_TYPE scroll_type=ONSCREEN, bool force=true)
	Scrolls to the leader of a certain side. More...

virtual void	select_hex (map_location hex) override
	Function to display a location as selected. More...

virtual void	highlight_hex (map_location hex) override
	Function to highlight a location. More...

void	display_unit_hex (map_location hex)
	Change the unit to be displayed in the sidebar. More...

void	highlight_reach (const pathfind::paths &paths_list)
	Sets the paths that are currently displayed as available for the unit to move along. More...

void	highlight_another_reach (const pathfind::paths &paths_list, const map_location &goal=map_location::null_location())
	Add more paths to highlight. More...

const std::set< map_location > &	units_that_can_reach_goal () const
	Return the locations of units that can reach goal (. More...

bool	unhighlight_reach ()
	Reset highlighting of paths. More...

void	set_route (const pathfind::marked_route *route)
	Sets the route along which footsteps are drawn to show movement of a unit. More...

const pathfind::marked_route &	get_route ()
	Gets the route along which footsteps are drawn to show movement of a unit. More...

void	float_label (const map_location &loc, const std::string &text, const color_t &color)
	Function to float a label above a tile. More...

void	draw_movement_info (const map_location &loc)
	Draws the movement info (turns available) for a given location. More...

void	invalidate_unit ()
	Function to invalidate that unit status displayed on the sidebar. More...

void	invalidate_unit_after_move (const map_location &src, const map_location &dst)
	Same as invalidate_unit() if moving the displayed unit. More...

virtual const time_of_day &	get_time_of_day (const map_location &loc) const override

virtual bool	has_time_area () const override

virtual void	update () override
	TLD update() override. More...

virtual void	layout () override
	TLD layout() override. More...

virtual void	render () override
	TLD render() override. More...

void	set_attack_indicator (const map_location &src, const map_location &dst)
	Set the attack direction indicator. More...

void	clear_attack_indicator ()

const map_location &	get_attack_indicator_src ()

std::string	attack_indicator_direction () const
	Function to get attack direction suffix. More...

t_translation::terrain_code	get_terrain_on (int palx, int paly, int x, int y)

virtual const map_location &	displayed_unit_hex () const override
	Virtual functions shadowed in game_display. More...

virtual int	playing_side () const override
	The playing team is the team whose turn it is. More...

std::string	current_team_name () const

display_chat_manager &	get_chat_manager ()

void	begin_game ()

virtual bool	in_game () const override

void	set_game_mode (const game_mode mode)

void	needs_rebuild (bool b)
	Sets whether the screen (map visuals) needs to be rebuilt. More...

bool	maybe_rebuild ()
	Rebuilds the screen if needs_rebuild(true) was previously called, and resets the flag. More...

Public Member Functions inherited from display
	display (const display_context *dc, std::weak_ptr< wb::manager > wb, reports &reports_object, const std::string &theme_id, const config &level)

virtual	~display ()

bool	show_everything () const

const gamemap &	get_map () const

const std::vector< team > &	get_teams () const

std::size_t	playing_team () const
	The playing team is the team whose turn it is. More...

bool	team_valid () const

std::size_t	viewing_team () const
	The viewing team is the team currently viewing the game. More...

int	viewing_side () const
	The 1-based equivalent of the 0-based viewing_team() function. More...

void	set_team (std::size_t team, bool observe=false)
	Sets the team controlled by the player using the computer. More...

void	set_playing_team (std::size_t team)
	set_playing_team sets the team whose turn it currently is More...

void	clear_exclusive_draws ()
	Cancels all the exclusive draw requests. More...

const unit_map &	get_units () const

bool	add_exclusive_draw (const map_location &loc, unit &unit)
	Allows a unit to request to be the only one drawn in its hex. More...

std::string	remove_exclusive_draw (const map_location &loc)
	Cancels an exclusive draw request. More...

void	add_overlay (const map_location &loc, const std::string &image, const std::string &halo="", const std::string &team_name="", const std::string &item_id="", bool visible_under_fog=true, float submerge=0.0f, float z_order=0)
	Functions to add and remove overlays from locations. More...

void	remove_overlay (const map_location &loc)
	remove_overlay will remove all overlays on a tile. More...

void	remove_single_overlay (const map_location &loc, const std::string &toDelete)
	remove_single_overlay will remove a single overlay from a tile More...

void	reload_map ()
	Updates internals that cache map size. More...

void	change_display_context (const display_context *dc)

const display_context &	get_disp_context () const

halo::manager &	get_halo_manager ()

void	update_tod (const time_of_day *tod_override=nullptr)
	Applies r,g,b coloring to the map. More...

void	adjust_color_overlay (int r, int g, int b)
	Add r,g,b to the colors for all images displayed on the map. More...

tod_color	get_color_overlay () const

virtual bool	in_editor () const

const rect &	minimap_area () const
	mapx is the width of the portion of the display which shows the game area. More...

const rect &	palette_area () const

const rect &	unit_image_area () const

rect	max_map_area () const
	Returns the maximum area used for the map regardless to resolution and view size. More...

rect	map_area () const
	Returns the area used for the map. More...

rect	map_outside_area () const
	Returns the available area for a map, this may differ from the above. More...

const map_location	hex_clicked_on (int x, int y) const
	given x,y co-ordinates of an onscreen pixel, will return the location of the hex that this pixel corresponds to. More...

const map_location	pixel_position_to_hex (int x, int y) const
	given x,y co-ordinates of a pixel on the map, will return the location of the hex that this pixel corresponds to. More...

map_location	minimap_location_on (int x, int y)
	given x,y co-ordinates of the mouse, will return the location of the hex in the minimap that the mouse is currently over, or an invalid location if the mouse isn't over the minimap. More...

const map_location &	selected_hex () const

const map_location &	mouseover_hex () const

void	invalidate_game_status ()
	Function to invalidate the game status displayed on the sidebar. More...

int	get_location_x (const map_location &loc) const
	Functions to get the on-screen positions of hexes. More...

int	get_location_y (const map_location &loc) const

point	get_location (const map_location &loc) const

const rect_of_hexes	hexes_under_rect (const SDL_Rect &r) const
	Return the rectangular area of hexes overlapped by r (r is in screen coordinates) More...

const rect_of_hexes	get_visible_hexes () const
	Returns the rectangular area of visible hexes. More...

bool	shrouded (const map_location &loc) const
	Returns true if location (x,y) is covered in shroud. More...

bool	fogged (const map_location &loc) const
	Returns true if location (x,y) is covered in fog. More...

surface	screenshot (bool map_screenshot=false)
	Capture a (map-)screenshot into a surface. More...

void	queue_rerender ()
	Marks everything for rendering including all tiles and sidebar. More...

void	queue_repaint ()
	Queues repainting to the screen, but doesn't rerender. More...

void	add_redraw_observer (std::function< void(display &)> f)
	Adds a redraw observer, a function object to be called when a full rerender is queued. More...

void	clear_redraw_observers ()
	Clear the redraw observers. More...

theme &	get_theme ()

void	set_theme (const std::string &new_theme)

std::shared_ptr< gui::button >	find_action_button (const std::string &id)
	Retrieves a pointer to a theme UI button. More...

std::shared_ptr< gui::button >	find_menu_button (const std::string &id)

void	create_buttons ()

void	layout_buttons ()

void	draw_buttons ()

void	hide_buttons ()
	Hide theme buttons so they don't draw. More...

void	unhide_buttons ()
	Unhide theme buttons so they draw again. More...

void	refresh_report (const std::string &report_name, const config *new_cfg=nullptr)
	Update the given report. More...

void	draw_report (const std::string &report_name, bool test_run=false)
	Draw the specified report. More...

bool	draw_reports (const rect &region)
	Draw all reports in the given region. More...

void	draw_minimap_units ()

void	invalidate_all ()
	Function to invalidate all tiles. More...

bool	invalidate (const map_location &loc)
	Function to invalidate a specific tile for redrawing. More...

bool	invalidate (const std::set< map_location > &locs)

bool	propagate_invalidation (const std::set< map_location > &locs)
	If this set is partially invalidated, invalidate all its hexes. More...

bool	invalidate_locations_in_rect (const SDL_Rect &rect)
	invalidate all hexes under the rectangle rect (in screen coordinates) More...

bool	invalidate_visible_locations_in_rect (const SDL_Rect &rect)

void	invalidate_animations ()
	Function to invalidate animated terrains and units which may have changed. More...

void	invalidate_animations_location (const map_location &loc)
	Per-location invalidation called by invalidate_animations() Extra game per-location invalidation (village ownership) More...

void	reset_standing_animations ()

terrain_builder &	get_builder ()

void	update_fps_label ()

void	clear_fps_label ()

void	update_fps_count ()

void	rebuild_all ()
	Rebuild all dynamic terrain. More...

const theme::action *	action_pressed ()

const theme::menu *	menu_pressed ()

void	set_diagnostic (const std::string &msg)

double	turbo_speed () const

void	bounds_check_position ()

void	bounds_check_position (int &xpos, int &ypos) const

bool	scroll (int xmov, int ymov, bool force=false)
	Scrolls the display by xmov,ymov pixels. More...

bool	set_zoom (bool increase)
	Zooms the display in (true) or out (false). More...

bool	set_zoom (unsigned int amount, const bool validate_value_and_set_index=true)
	Sets the display zoom to the specified amount. More...

void	toggle_default_zoom ()
	Sets the zoom amount to the default. More...

bool	view_locked () const

void	set_view_locked (bool value)
	Sets whether the map view is locked (e.g. More...

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. More...

void	scroll_to_tiles (map_location loc1, map_location loc2, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, double add_spacing=0.0, bool force=true)
	Scroll such that location loc1 is on-screen. More...

void	scroll_to_tiles (const std::vector< map_location >::const_iterator &begin, const std::vector< map_location >::const_iterator &end, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, bool only_if_possible=false, double add_spacing=0.0, bool force=true)
	Scroll to fit as many locations on-screen as possible, starting with the first. More...

void	scroll_to_tiles (const std::vector< map_location > &locs, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, bool only_if_possible=false, double add_spacing=0.0, bool force=true)
	Scroll to fit as many locations on-screen as possible, starting with the first. More...

events::generic_event &	scroll_event () const
	Expose the event, so observers can be notified about map scrolling. More...

bool	tile_fully_on_screen (const map_location &loc) const
	Check if a tile is fully visible on screen. More...

bool	tile_nearly_on_screen (const map_location &loc) const
	Checks if location loc or one of the adjacent tiles is visible on screen. More...

void	set_prevent_draw (bool pd=true)
	Prevent the game display from drawing. More...

bool	get_prevent_draw ()

void	fade_tod_mask (const std::string &old, const std::string &new_)
	ToD mask smooth fade. More...

void	fade_to (const color_t &color, int duration)
	Screen fade. More...

void	set_fade (const color_t &color)

virtual bool	expose (const rect &region) override
	Paint the indicated region to the screen. More...

virtual rect	screen_location () override
	Return the current draw location of the display, on the screen. More...

map_labels &	labels ()

const map_labels &	labels () const

void	announce (const std::string &msg, const color_t &color=font::GOOD_COLOR, const announce_options &options=announce_options())
	Announce a message prominently. More...

void	recalculate_minimap ()
	Schedule the minimap for recalculation. More...

void	redraw_minimap ()
	Schedule the minimap to be redrawn. More...

void	blindfold (bool flag)

bool	is_blindfolded () const

void	write (config &cfg) const

void	init_flags ()
	Init the flag list and the team colors used by ~TC. More...

void	reinit_flags_for_team (const team &)
	Rebuild the flag list (not team colors) for a single side. More...

void	reset_reports (reports &reports_object)

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. More...

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. More...

void	add_arrow (arrow &)

void	remove_arrow (arrow &)

void	update_arrow (arrow &a)
	Called by arrow objects when they change. More...

bool	debug_flag_set (DEBUG_FLAG flag) const

void	set_debug_flag (DEBUG_FLAG flag, bool value)

void	toggle_debug_flag (DEBUG_FLAG flag)

Static Public Member Functions
static game_display *	get_singleton ()

static int &	debug_highlight (const map_location &loc)
	annotate hex with number, useful for debugging or UI prototype More...

static void	clear_debug_highlights ()

Static Public Member Functions inherited from display
static display *	get_singleton ()
	Returns the display object if a display object exists. More...

static bool	outside_area (const SDL_Rect &area, const int x, const int y)
	Check if the bbox of the hex at x,y has pixels outside the area rectangle. More...

static int	hex_width ()
	Function which returns the width of a hex in pixels, up to where the next hex starts. More...

static int	hex_size ()
	Function which returns the size of a hex in pixels (from top tip to bottom tip or left edge to right edge). More...

static double	get_zoom_factor ()
	Returns the current zoom factor. More...

static rect	scaled_to_zoom (const SDL_Rect &r)
	Scale the width and height of a rect by the current zoom factor. More...

static point	scaled_to_zoom (const point &p)

static bool	zoom_at_max ()

static bool	zoom_at_min ()

static submerge_data	get_submerge_data (const rect &dest, double submerge, const point &size, uint8_t alpha, bool hreverse, bool vreverse)

Protected Member Functions
virtual void	draw_invalidated () override
	Only called when there's actual redrawing to do. More...

virtual void	draw_hex (const map_location &loc) override
	Redraws a single gamemap location. More...

virtual overlay_map &	get_overlays () override
	Inherited from display. More...

Protected Member Functions inherited from display
map_location	get_middle_location () const

virtual rect	get_clip_rect () const
	Get the clipping rectangle for drawing. More...

void	get_terrain_images (const map_location &loc, const std::string &timeid, TERRAIN_TYPE terrain_type)

std::vector< texture >	get_fog_shroud_images (const map_location &loc, image::TYPE image_type)

void	scroll_to_xy (int screenxpos, int screenypos, SCROLL_TYPE scroll_type, bool force=true)

void	drawing_buffer_commit ()
	Draws the drawing_buffer_ and clears it. More...

bool	draw_all_panels (const rect &region)
	Redraws all panels intersecting the given region. More...

void	process_reachmap_changes ()

Protected Member Functions inherited from gui2::top_level_drawable
	top_level_drawable ()

virtual	~top_level_drawable ()

	top_level_drawable (const top_level_drawable &)

top_level_drawable &	operator= (const top_level_drawable &)

	top_level_drawable (top_level_drawable &&)

top_level_drawable &	operator= (top_level_drawable &&)

Protected Attributes
std::set< map_location >	units_that_can_reach_goal_

Protected Attributes inherited from display
const display_context *	dc_

halo::manager	halo_man_

std::weak_ptr< wb::manager >	wb_

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 More...

std::size_t	currentTeam_

bool	dont_show_all_

int	xpos_
	Position of the top-left corner of the viewport, in pixels. More...

int	ypos_

bool	view_locked_

theme	theme_

int	zoom_index_

const std::unique_ptr< fake_unit_manager >	fake_unit_man_

const std::unique_ptr< terrain_builder >	builder_

std::function< rect(rect)>	minimap_renderer_

SDL_Rect	minimap_location_

bool	redraw_background_

bool	invalidateAll_

int	diagnostic_label_

bool	invalidateGameStatus_

const std::unique_ptr< map_labels >	map_labels_

reports *	reports_object_

events::generic_event	scroll_event_
	Event raised when the map is being scrolled. More...

boost::circular_buffer< unsigned >	frametimes_

int	current_frame_sample_ = 0

unsigned int	fps_counter_

std::chrono::seconds	fps_start_

unsigned int	fps_actual_

uint32_t	last_frame_finished_ = 0u

std::map< std::string, rect >	reportLocations_

std::map< std::string, texture >	reportSurfaces_

std::map< std::string, config >	reports_

std::vector< std::shared_ptr< gui::button > >	menu_buttons_

std::vector< std::shared_ptr< gui::button > >	action_buttons_

std::set< map_location >	invalidated_

texture	tod_hex_mask1 = {}

texture	tod_hex_mask2 = {}

uint8_t	tod_hex_alpha1 = 0

uint8_t	tod_hex_alpha2 = 0

std::vector< std::string >	fog_images_

std::vector< std::string >	shroud_images_

map_location	selectedHex_

map_location	mouseoverHex_

CKey	keys_

bool	animate_map_
	Local cache for preferences::animate_map, since it is constantly queried. More...

bool	animate_water_
	Local version of preferences::animate_water, used to detect when it's changed. More...

std::size_t	activeTeam_

std::list< draw_helper >	drawing_buffer_

bool	map_screenshot_
	Used to indicate to drawing functions that we are doing a map screenshot. More...

reach_map	reach_map_

reach_map	reach_map_old_

bool	reach_map_changed_

Private Member Functions
	game_display (const game_display &)

void	operator= (const game_display &)

void	invalidate_route ()

Private Attributes
overlay_map	overlay_map_

map_location	attack_indicator_src_

map_location	attack_indicator_dst_

pathfind::marked_route	route_

map_location	displayedUnitHex_

bool	first_turn_

bool	in_game_

const std::unique_ptr< display_chat_manager >	chat_man_

game_mode	mode_

bool	needs_rebuild_

Static Private Attributes
static std::map< map_location, int >	debugHighlights_

Additional Inherited Members
Protected Types inherited from display
enum	TERRAIN_TYPE { BACKGROUND , FOREGROUND }

typedef std::map< map_location, std::string >	exclusive_unit_draw_requests_t

typedef std::map< map_location, unsigned int >	reach_map

typedef std::map< map_location, std::vector< overlay > >	overlay_map

Static Protected Member Functions inherited from display
static void	fill_images_list (const std::string &prefix, std::vector< std::string > &images)

static const std::string &	get_variant (const std::vector< std::string > &variants, const map_location &loc)

Static Protected Attributes inherited from display
static unsigned int	zoom_ = DefaultZoom
	The current zoom, in pixels (on screen) per 72 pixels (in the graphic assets), i.e., 72 means 100%. More...

static unsigned int	last_zoom_ = SmallZoom
	The previous value of zoom_. More...

static display *	singleton_ = nullptr

Detailed Description

Definition at line 30 of file game_display.hpp.

Member Enumeration Documentation

◆ game_mode

enum game_display::game_mode

Sets the linger mode for the display.

There have been some discussions on what to do with fog and shroud the extra variables make it easier to modify the behavior. There might even be a split between victory and defeat.

Todo:: if the current implementation is wanted we can change the stuff back to a boolean

Enumerator
RUNNING	no linger overlay, show fog and shroud.
LINGER

Definition at line 217 of file game_display.hpp.

Constructor & Destructor Documentation

◆ game_display() [1/2]

game_display::game_display	(	game_board &	board,
		std::weak_ptr< wb::manager >	wb,
		reports &	reports_object,
		const std::string &	theme_id,
		const config &	level
	)

Definition at line 63 of file game_display.cpp.

◆ ~game_display()

game_display::~game_display ( )

Definition at line 82 of file game_display.cpp.

References chat_man_, DBG_DP, and utils::get_unknown_exception_type().

◆ game_display() [2/2]

game_display::game_display ( const game_display & )

private

Member Function Documentation

◆ attack_indicator_direction()

std::string game_display::attack_indicator_direction ( ) const

inline

Function to get attack direction suffix.

Definition at line 179 of file game_display.hpp.

References attack_indicator_dst_, attack_indicator_src_, map_location::get_relative_dir(), and map_location::write_direction().

Referenced by draw_hex().

◆ begin_game()

void game_display::begin_game ( )

Definition at line 639 of file game_display.cpp.

References display::create_buttons(), in_game_, and display::invalidate_all().

◆ clear_attack_indicator()

void game_display::clear_attack_indicator ( )

Definition at line 625 of file game_display.cpp.

References map_location::null_location(), and set_attack_indicator().

Referenced by events::mouse_handler::attack_enemy_(), events::mouse_handler::mouse_motion(), events::mouse_handler::move_action(), events::mouse_handler::save_whiteboard_attack(), events::mouse_handler::select_hex(), events::mouse_handler::teleport_action(), and events::mouse_handler::touch_motion().

◆ clear_debug_highlights()

static void game_display::clear_debug_highlights ( )

inlinestatic

Definition at line 195 of file game_display.hpp.

References debugHighlights_.

◆ current_team_name()

std::string game_display::current_team_name ( ) const

Definition at line 630 of file game_display.cpp.

References display::currentTeam_, display::dc_, display::team_valid(), and display_context::teams().

◆ debug_highlight()

int & game_display::debug_highlight ( const map_location & loc )

static

annotate hex with number, useful for debugging or UI prototype

Definition at line 605 of file game_display.cpp.

References game_config::debug, and debugHighlights_.

◆ display_unit_hex()

void game_display::display_unit_hex ( map_location hex )

Change the unit to be displayed in the sidebar.

This is used when selecting or highlighting is not wanted.

< Lasts for whole method.

Definition at line 141 of file game_display.cpp.

References display::dc_, displayedUnitHex_, display::dont_show_all_, resources::gameboard, game_board::get_visible_unit(), invalidate_unit(), synced_context::is_synced(), display_context::teams(), map_location::valid(), and display::viewing_team().

Referenced by events::mouse_handler::attack_enemy_(), game_lua_kernel::intf_highlight_hex(), select_hex(), and unit_display::unit_healing().

◆ displayed_unit_hex()

virtual const map_location& game_display::displayed_unit_hex ( ) const

inlineoverridevirtual

Virtual functions shadowed in game_display.

These are needed to generate reports easily, without dynamic casting. Hope to factor out eventually.

Reimplemented from display.

Definition at line 189 of file game_display.hpp.

References displayedUnitHex_.

Referenced by game_lua_kernel::intf_get_displayed_unit().

◆ draw_hex()

void game_display::draw_hex ( const map_location & loc )

overrideprotectedvirtual

Redraws a single gamemap location.

Reimplemented from display.

Definition at line 229 of file game_display.cpp.

References attack_indicator_direction(), attack_indicator_dst_, attack_indicator_src_, font::BAD_COLOR, draw::blit(), display::currentTeam_, display::dc_, game_config::debug, debugHighlights_, display::draw_hex(), draw_movement_info(), display::draw_text_in_hex(), display::drawing_buffer_add(), footsteps_images(), resources::gameboard, cursor::get(), display::get_map(), image::get_texture(), game_board::get_visible_unit(), image::HEXED, is_shrouded(), display::LAYER_ATTACK_INDICATOR, display::LAYER_FOOTSTEPS, display::LAYER_LINGER_OVERLAY, display::LAYER_MOUSEOVER_BOTTOM, display::LAYER_MOUSEOVER_TOP, display::LAYER_MOVE_INFO, display::LAYER_REACHMAP, display::LAYER_SELECTED_HEX, game_config::images::linger, display::map_screenshot_, mode_, display::mouseoverHex_, gamemap_base::on_board(), display::reach_map_, route_, RUNNING, game_config::images::selected, display::selectedHex_, display::shrouded(), unit::side(), t, display_context::teams(), image::TOD_COLORED, game_config::images::unreachable, display::viewing_team(), w, cursor::WAIT, and display::wb_.

◆ draw_invalidated()

void game_display::draw_invalidated ( )

overrideprotectedvirtual

Only called when there's actual redrawing to do.

Loops through invalidated locations and redraws them. Derived classes can override this, possibly to insert pre- or post-processing around a call to the base class's function.

Reimplemented from display.

Definition at line 197 of file game_display.cpp.

References display::draw_invalidated(), display::exclusive_unit_draw_requests_, display::fake_unit_man_, display::invalidated_, and unit_drawer::redraw_unit().

◆ draw_movement_info()

void game_display::draw_movement_info ( const map_location & loc )

Draws the movement info (turns available) for a given location.

Definition at line 379 of file game_display.cpp.

References draw::blit(), display::dc_, display::draw_text_in_hex(), display::drawing_buffer_add(), unit_map::end(), unit_map::find(), display::get_map(), gamemap_base::get_terrain(), image::get_texture(), image::HEXED, display::LAYER_MOVE_INFO, pathfind::marked_route::marks, font::NORMAL_COLOR, game_config::red_to_green(), route_, pathfind::marked_route::steps, display_context::units(), movetype::UNREACHABLE, w, and display::wb_.

Referenced by draw_hex().

◆ float_label()

void game_display::float_label	(	const map_location &	loc,
		const std::string &	text,
		const color_t &	color
	)

Function to float a label above a tile.

Definition at line 588 of file game_display.cpp.

References font::add_floating_label(), font::ANCHOR_LABEL_MAP, display::fogged(), display::get_location_x(), display::get_location_y(), display::get_zoom_factor(), font::floating_label::set_color(), font::floating_label::set_font_size(), font::floating_label::set_lifetime(), font::floating_label::set_move(), font::floating_label::set_position(), font::floating_label::set_scroll_mode(), preferences::show_floating_labels(), font::SIZE_FLOAT_LABEL, display::turbo_speed(), and display::zoom_.

Referenced by game_lua_kernel::intf_float_label(), and unit_frame::redraw().

◆ get_attack_indicator_src()

const map_location& game_display::get_attack_indicator_src ( )

inline

Definition at line 176 of file game_display.hpp.

References attack_indicator_src_.

Referenced by REPORT_GENERATOR().

◆ get_chat_manager()

display_chat_manager& game_display::get_chat_manager ( )

inline

Definition at line 202 of file game_display.hpp.

References chat_man_.

Referenced by chat_message(), wfl::builtins::DEFINE_WFL_FUNCTION(), gui2::dialogs::lua_interpreter::display(), ai::formula_ai::display_message(), do_replay_handle(), game_lua_kernel::intf_clear_messages(), ai::readonly_context_impl::log_message(), game_lua_kernel::lua_chat(), playmp_controller::process_network_data_impl(), game_events::wml_event_pump::show_wml_messages(), and gui::floating_textbox::tab().

◆ get_overlays()

display::overlay_map & game_display::get_overlays ( )

overrideprotectedvirtual

Inherited from display.

Implements display.

Definition at line 663 of file game_display.cpp.

References overlay_map_.

◆ get_route()

const pathfind::marked_route& game_display::get_route ( )

inline

Gets the route along which footsteps are drawn to show movement of a unit.

If no route is currently being shown, the array get_route().steps will be empty.

Definition at line 117 of file game_display.hpp.

References route_.

Referenced by unit_moves().

◆ get_singleton()

static game_display* game_display::get_singleton ( )

inlinestatic

Definition at line 40 of file game_display.hpp.

References display::singleton_.

Referenced by actions::undo_list::apply_shroud_changes(), chat_message(), wb::manager::create_temp_move(), wfl::builtins::DEFINE_WFL_FUNCTION(), ai::formula_ai::display_message(), do_replay_handle(), wb::manager::erase_temp_move(), game_events::wml_event_pump::flush_messages(), ai::readonly_context_impl::log_message(), game_events::wml_event_pump::operator()(), gui2::dialogs::mp_change_control::pre_show(), game_events::wml_event_pump::process_event(), playmp_controller::process_network_change_controller_impl(), playmp_controller::process_network_data_impl(), playmp_controller::process_network_side_drop_impl(), game_events::wml_event_pump::raise(), actions::undo_list::redo(), unit_frame::redraw(), REPORT_GENERATOR(), wfl::formula_debugger::show_gui(), game_events::wml_event_pump::show_wml_messages(), SYNCED_COMMAND_HANDLER_FUNCTION(), gui::floating_textbox::tab(), actions::undo_list::undo(), actions::undo::move_action::undo(), actions::undo::recall_action::undo(), actions::undo::recruit_action::undo(), unit_display::unit_healing(), unit_moves(), unit_display::unit_recruited(), game_events::WML_HANDLER_FUNCTION(), and wb::highlighter::~highlighter().

◆ get_terrain_on()

t_translation::terrain_code game_display::get_terrain_on	(	int	palx,
		int	paly,
		int	x,
		int	y
	)

◆ get_time_of_day()

const time_of_day & game_display::get_time_of_day ( const map_location & loc ) const

overridevirtual

Reimplemented from display.

Definition at line 336 of file game_display.cpp.

References tod_manager::get_time_of_day(), and resources::tod_manager.

◆ has_time_area()

bool game_display::has_time_area ( ) const

overridevirtual

Reimplemented from display.

Definition at line 341 of file game_display.cpp.

References tod_manager::has_time_area(), and resources::tod_manager.

◆ highlight_another_reach()

void game_display::highlight_another_reach	(	const pathfind::paths &	paths_list,
		const map_location &	goal = `map_location::null_location()`
	)

Add more paths to highlight.

Print numbers where they overlap. Used by Show Enemy Moves. If goal is not null_location, highlight enemy units that can reach goal.

Definition at line 538 of file game_display.cpp.

References pathfind::paths::dest_vect::contains(), pathfind::paths::step::curr, pathfind::paths::destinations, pathfind::paths::dest_vect::find(), pathfind::paths::dest_vect::get_path(), map_location::null_location(), display::reach_map_, display::reach_map_changed_, and units_that_can_reach_goal_.

Referenced by highlight_reach(), and events::mouse_handler::select_hex().

◆ highlight_hex()

void game_display::highlight_hex ( map_location hex )

overridevirtual

Function to highlight a location.

If a unit is in the location, it will be displayed in the sidebar. Selection is used when a unit has been clicked on, while highlighting is used when a location has been moused over.

< Lasts for whole method.

Reimplemented from display.

Definition at line 117 of file game_display.cpp.

References unit_map::count(), display::dc_, displayedUnitHex_, display::dont_show_all_, resources::gameboard, game_board::get_visible_unit(), display::highlight_hex(), display::invalidate_game_status(), invalidate_unit(), synced_context::is_synced(), display::mouseoverHex_, display::selectedHex_, display_context::teams(), display_context::units(), and display::viewing_team().

Referenced by events::mouse_handler::attack_enemy_(), game_lua_kernel::intf_deselect_hex(), game_lua_kernel::intf_highlight_hex(), events::mouse_handler::mouse_motion(), and events::mouse_handler::touch_motion().

◆ highlight_reach()

void game_display::highlight_reach ( const pathfind::paths & paths_list )

Sets the paths that are currently displayed as available for the unit to move along.

All other paths will be grayed out.

Definition at line 532 of file game_display.cpp.

References highlight_another_reach(), and unhighlight_reach().

Referenced by events::mouse_handler::select_hex(), and events::mouse_handler::show_reach_for_unit().

◆ in_game()

virtual bool game_display::in_game ( ) const

inlineoverridevirtual

Reimplemented from display.

Definition at line 206 of file game_display.hpp.

References in_game_.

◆ invalidate_route()

void game_display::invalidate_route ( )

private

Definition at line 566 of file game_display.cpp.

References i, display::invalidate(), route_, and pathfind::marked_route::steps.

Referenced by set_route().

◆ invalidate_unit()

void game_display::invalidate_unit ( )

inline

Function to invalidate that unit status displayed on the sidebar.

Definition at line 126 of file game_display.hpp.

References display::invalidateGameStatus_.

Referenced by actions::undo_list::apply_shroud_changes(), display_unit_hex(), highlight_hex(), invalidate_unit_after_move(), SYNCED_COMMAND_HANDLER_FUNCTION(), and unit_display::unit_recruited().

◆ invalidate_unit_after_move()

void game_display::invalidate_unit_after_move	(	const map_location &	src,
		const map_location &	dst
	)

Same as invalidate_unit() if moving the displayed unit.

Definition at line 155 of file game_display.cpp.

References displayedUnitHex_, and invalidate_unit().

Referenced by game_lua_kernel::intf_teleport().

◆ layout()

void game_display::layout ( )

overridevirtual

TLD layout() override.

Replaces old refresh_reports(). Be sure to call the base class method as well.

This updates some reports, like clock, that need to be refreshed every frame.

Reimplemented from display.

Definition at line 346 of file game_display.cpp.

References display::invalidateGameStatus_, display::layout(), display::refresh_report(), reports::report_list(), display::reports_object_, and display::team_valid().

◆ maybe_rebuild()

bool game_display::maybe_rebuild ( )

Rebuilds the screen if needs_rebuild(true) was previously called, and resets the flag.

Definition at line 652 of file game_display.cpp.

References display::invalidate_all(), needs_rebuild_, display::rebuild_all(), and display::recalculate_minimap().

Referenced by game_lua_kernel::intf_redraw(), game_events::wml_event_pump::process_event(), and SYNCED_COMMAND_HANDLER_FUNCTION().

◆ needs_rebuild()

void game_display::needs_rebuild ( bool b )

Sets whether the screen (map visuals) needs to be rebuilt.

This is typically after the map has been changed by wml.

Definition at line 646 of file game_display.cpp.

References b, and needs_rebuild_.

Referenced by impl_merge_terrain(), intf_terrain_mask(), SYNCED_COMMAND_HANDLER_FUNCTION(), and game_events::WML_HANDLER_FUNCTION().

◆ new_turn()

void game_display::new_turn ( )

Update lighting settings.

Should be called on every new turn.

Definition at line 91 of file game_display.cpp.

References display::fade_tod_mask(), first_turn_, tod_manager::get_previous_time_of_day(), tod_manager::get_time_of_day(), time_of_day::image_mask, resources::tod_manager, and display::update_tod().

Referenced by game_lua_kernel::intf_replace_schedule(), SYNCED_COMMAND_HANDLER_FUNCTION(), and game_events::WML_HANDLER_FUNCTION().

◆ observers()

virtual const std::set<std::string>& game_display::observers ( ) const

inlineoverridevirtual

Reimplemented from display.

Definition at line 52 of file game_display.hpp.

References chat_man_.

Referenced by events::menu_handler::has_friends(), and gui2::dialogs::mp_change_control::pre_show().

◆ operator=()

void game_display::operator= ( const game_display & )

private

◆ playing_side()

virtual int game_display::playing_side ( ) const

inlineoverridevirtual

The playing team is the team whose turn it is.

Reimplemented from display.

Definition at line 198 of file game_display.hpp.

References display::activeTeam_.

Referenced by playmp_controller::process_network_change_controller_impl(), and playmp_controller::process_network_side_drop_impl().

◆ render()

void game_display::render ( )

overridevirtual

TLD render() override.

Replaces old post_draw(). Be sure to call the base class method as well.

This calls the whiteboard's post-draw method after rendering.

Reimplemented from display.

Definition at line 188 of file game_display.cpp.

References display::render(), w, and display::wb_.

◆ scroll_to_leader()

void game_display::scroll_to_leader	(	int	side,
		SCROLL_TYPE	scroll_type = `ONSCREEN`,
		bool	force = `true`
	)

Scrolls to the leader of a certain side.

This will normally be the playing team.

Definition at line 163 of file game_display.cpp.

References display::dc_, unit_map::find_leader(), display_context::get_team(), display::scroll_to_tile(), display_context::units(), unit_map::iterator_base< iter_types >::valid(), and display::viewing_side().

Referenced by events::menu_handler::status_table().

◆ select_hex()

void game_display::select_hex ( map_location hex )

overridevirtual

Function to display a location as selected.

If a unit is in the location, and there is no unit in the currently highlighted hex, the unit will be displayed in the sidebar.

Reimplemented from display.

Definition at line 107 of file game_display.cpp.

References display_unit_hex(), display::fogged(), display::select_hex(), and map_location::valid().

Referenced by events::mouse_handler::attack_enemy_(), events::mouse_handler::move_action(), events::mouse_handler::move_unit_along_current_route(), events::mouse_handler::save_whiteboard_attack(), events::mouse_handler::select_hex(), and events::mouse_handler::select_teleport().

◆ set_attack_indicator()

void game_display::set_attack_indicator	(	const map_location &	src,
		const map_location &	dst
	)

Set the attack direction indicator.

Definition at line 611 of file game_display.cpp.

References attack_indicator_dst_, attack_indicator_src_, and display::invalidate().

Referenced by clear_attack_indicator(), events::mouse_handler::mouse_motion(), and events::mouse_handler::touch_motion().

◆ set_game_mode()

void game_display::set_game_mode ( const game_mode mode )

Definition at line 371 of file game_display.cpp.

References display::invalidate_all(), and mode_.

◆ set_route()

void game_display::set_route ( const pathfind::marked_route * route )

Sets the route along which footsteps are drawn to show movement of a unit.

If nullptr, no route is displayed. route does not have to remain valid after being set.

Definition at line 574 of file game_display.cpp.

References invalidate_route(), pathfind::marked_route::marks, route_, and pathfind::marked_route::steps.

Referenced by events::mouse_handler::mouse_motion(), events::mouse_handler::move_action(), events::mouse_handler::move_unit_along_current_route(), events::mouse_handler::save_whiteboard_attack(), events::mouse_handler::select_hex(), events::mouse_handler::select_teleport(), events::mouse_handler::set_current_paths(), events::mouse_handler::show_reach_for_unit(), events::mouse_handler::teleport_action(), and events::mouse_handler::touch_motion().

◆ unhighlight_reach()

bool game_display::unhighlight_reach ( )

Reset highlighting of paths.

Definition at line 554 of file game_display.cpp.

References display::reach_map_, display::reach_map_changed_, and units_that_can_reach_goal_.

Referenced by events::mouse_handler::attack_enemy_(), highlight_reach(), events::mouse_handler::mouse_motion(), events::mouse_handler::move_action(), events::mouse_handler::move_unit_along_current_route(), events::mouse_handler::save_whiteboard_attack(), events::mouse_handler::select_hex(), events::mouse_handler::set_current_paths(), and events::mouse_handler::touch_motion().

◆ units_that_can_reach_goal()

const std::set<map_location>& game_display::units_that_can_reach_goal ( ) const

inline

Return the locations of units that can reach goal (.

See also: highlight_another_reach()).

Definition at line 101 of file game_display.hpp.

References units_that_can_reach_goal_.

Referenced by unit_drawer::unit_drawer().

◆ update()

void game_display::update ( )

overridevirtual

TLD update() override.

Replaces old pre_draw(). Be sure to call the base class method as well.

game_display does specific things related e.g. to unit rendering and calls the whiteboard pre-draw method here.

Todo:: FIXME: must modify changed, but best to do it at the floating_label level

Reimplemented from display.

Definition at line 172 of file game_display.cpp.

References chat_man_, display::process_reachmap_changes(), display::update(), w, and display::wb_.

Member Data Documentation

◆ attack_indicator_dst_

map_location game_display::attack_indicator_dst_

private

Definition at line 237 of file game_display.hpp.

Referenced by attack_indicator_direction(), draw_hex(), and set_attack_indicator().

◆ attack_indicator_src_

map_location game_display::attack_indicator_src_

private

Definition at line 236 of file game_display.hpp.

Referenced by attack_indicator_direction(), draw_hex(), get_attack_indicator_src(), and set_attack_indicator().

◆ chat_man_

const std::unique_ptr<display_chat_manager> game_display::chat_man_

private

Definition at line 247 of file game_display.hpp.

Referenced by get_chat_manager(), observers(), update(), and ~game_display().

◆ debugHighlights_

std::map< map_location, int > game_display::debugHighlights_

staticprivate

Definition at line 252 of file game_display.hpp.

Referenced by clear_debug_highlights(), debug_highlight(), and draw_hex().

◆ displayedUnitHex_

map_location game_display::displayedUnitHex_

private

Definition at line 243 of file game_display.hpp.

Referenced by display_unit_hex(), displayed_unit_hex(), highlight_hex(), and invalidate_unit_after_move().

◆ first_turn_

bool game_display::first_turn_

private

Definition at line 245 of file game_display.hpp.

Referenced by new_turn().

◆ in_game_

bool game_display::in_game_

private

Definition at line 245 of file game_display.hpp.

Referenced by begin_game(), and in_game().

◆ mode_

game_mode game_display::mode_

private

Definition at line 249 of file game_display.hpp.

Referenced by draw_hex(), and set_game_mode().

◆ needs_rebuild_

bool game_display::needs_rebuild_

private

Definition at line 254 of file game_display.hpp.

Referenced by maybe_rebuild(), and needs_rebuild().

◆ overlay_map_

overlay_map game_display::overlay_map_

private

Definition at line 233 of file game_display.hpp.

Referenced by get_overlays().

◆ route_

pathfind::marked_route game_display::route_

private

Definition at line 239 of file game_display.hpp.

Referenced by draw_hex(), draw_movement_info(), get_route(), invalidate_route(), and set_route().

◆ units_that_can_reach_goal_

std::set<map_location> game_display::units_that_can_reach_goal_

protected

Definition at line 169 of file game_display.hpp.

Referenced by highlight_another_reach(), unhighlight_reach(), and units_that_can_reach_goal().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ game_mode

Constructor & Destructor Documentation

◆ game_display() [1/2]

◆ ~game_display()

◆ game_display() [2/2]

Member Function Documentation

◆ attack_indicator_direction()

◆ begin_game()

◆ clear_attack_indicator()

◆ clear_debug_highlights()

◆ current_team_name()

◆ debug_highlight()

◆ display_unit_hex()

◆ displayed_unit_hex()

◆ draw_hex()

◆ draw_invalidated()

◆ draw_movement_info()

◆ float_label()

◆ get_attack_indicator_src()

◆ get_chat_manager()

◆ get_overlays()

◆ get_route()

◆ get_singleton()

◆ get_terrain_on()

◆ get_time_of_day()

◆ has_time_area()

◆ highlight_another_reach()

◆ highlight_hex()

◆ highlight_reach()

◆ in_game()

◆ invalidate_route()

◆ invalidate_unit()

◆ invalidate_unit_after_move()

◆ layout()

◆ maybe_rebuild()

◆ needs_rebuild()

◆ new_turn()

◆ observers()

◆ operator=()

◆ playing_side()

◆ render()

◆ scroll_to_leader()

◆ select_hex()

◆ set_attack_indicator()

◆ set_game_mode()

◆ set_route()

◆ unhighlight_reach()

◆ units_that_can_reach_goal()

◆ update()

Member Data Documentation

◆ attack_indicator_dst_

◆ attack_indicator_src_

◆ chat_man_

◆ debugHighlights_

◆ displayedUnitHex_

◆ first_turn_

◆ in_game_

◆ mode_

◆ needs_rebuild_

◆ overlay_map_

◆ route_

◆ units_that_can_reach_goal_