Encapsulates the map of the game. More...

#include <map.hpp>

Inheritance diagram for gamemap:

Classes
struct	overlay_rule

Public Types
enum	{ MAX_PLAYERS = 9 }
	Maximum number of players supported. More...

using	starting_positions = t_translation::starting_positions

Public Member Functions
const t_translation::ter_list &	underlying_mvt_terrain (const map_location &loc) const

const t_translation::ter_list &	underlying_def_terrain (const map_location &loc) const

const t_translation::ter_list &	underlying_union_terrain (const map_location &loc) const

std::string	get_terrain_string (const map_location &loc) const

std::string	get_terrain_editor_string (const map_location &loc) const

bool	is_village (const map_location &loc) const

int	gives_healing (const map_location &loc) const

bool	is_castle (const map_location &loc) const

bool	is_keep (const map_location &loc) const

const t_translation::ter_list &	underlying_mvt_terrain (const t_translation::terrain_code &terrain) const

const t_translation::ter_list &	underlying_def_terrain (const t_translation::terrain_code &terrain) const

const t_translation::ter_list &	underlying_union_terrain (const t_translation::terrain_code &terrain) const

std::string	get_terrain_string (const t_translation::terrain_code &terrain) const

std::string	get_terrain_editor_string (const t_translation::terrain_code &terrain) const

std::string	get_underlying_terrain_string (const t_translation::terrain_code &terrain) const

bool	is_village (const t_translation::terrain_code &terrain) const

int	gives_healing (const t_translation::terrain_code &terrain) const

bool	is_castle (const t_translation::terrain_code &terrain) const

bool	is_keep (const t_translation::terrain_code &terrain) const

const terrain_type &	get_terrain_info (const t_translation::terrain_code &terrain) const

const std::shared_ptr< terrain_type_data > &	tdata () const

	gamemap (const std::string &data)
	Loads a map. More...

virtual	~gamemap ()

void	read (const std::string &data, const bool allow_invalid=true)

std::string	write () const

void	overlay (const gamemap &m, map_location loc, const std::vector< overlay_rule > &rules=std::vector< overlay_rule >(), bool is_odd=false, bool ignore_special_locations=false)
	Overlays another map onto this one at the given position. More...

int	w () const
	Effective map width, in hexes. More...

int	h () const
	Effective map height, in hexes. More...

int	border_size () const
	Size of the map border. More...

int	total_width () const
	Real width of the map, including borders. More...

int	total_height () const
	Real height of the map, including borders. More...

const t_translation::terrain_code	operator[] (const map_location &loc) const

t_translation::terrain_code	get_terrain (const map_location &loc) const
	Looks up terrain at a particular location. More...

void	write_terrain (const map_location &loc, config &cfg) const
	Writes the terrain at loc to cfg. More...

void	set_starting_position (int side, const map_location &loc)
	Manipulate starting positions of the different sides. More...

map_location	starting_position (int side) const

void	set_special_location (const std::string &id, const map_location &loc)

map_location	special_location (const std::string &id) const

const std::string *	is_starting_position (const map_location &loc) const
	returns the side number of the side starting at position loc, 0 if no such side exists. More...

int	num_valid_starting_positions () const

bool	on_board (const map_location &loc) const
	Tell if a location is on the map. More...

bool	on_board_with_border (const map_location &loc) const

bool	empty () const
	Tell if the map is of 0 size. More...

const std::vector< map_location > &	villages () const
	Return a list of the locations of villages on the map. More...

const terrain_type &	get_terrain_info (const map_location &loc) const
	Shortcut to get_terrain_info(get_terrain(loc)). More...

const t_translation::ter_list &	get_terrain_list () const
	Gets the list of terrains. More...

void	set_terrain (const map_location &loc, const t_translation::terrain_code &terrain, const terrain_type_data::merge_mode mode=terrain_type_data::BOTH, bool replace_if_failed=false)
	Clobbers over the terrain at location 'loc', with the given terrain. More...

std::vector< map_location >	parse_location_range (const std::string &xvals, const std::string &yvals, bool with_border=false) const
	Parses ranges of locations into a vector of locations, using this map's dimensions as bounds. More...

const starting_positions &	special_locations () const

template<typename F >
void	for_each_loc (const F &f) const

template<typename F >
void	for_each_walkable_loc (const F &f) const

Static Public Member Functions
static void	overlay_impl (const t_translation::ter_map &m1, t_translation::starting_positions &m1_st, const t_translation::ter_map &m2, const t_translation::starting_positions &m2_st, std::function< void(const map_location &, const t_translation::terrain_code &, terrain_type_data::merge_mode, bool)> set_terrain, map_location loc, const std::vector< overlay_rule > &rules, bool is_odd, bool ignore_special_locations)

Static Public Attributes
static const int	default_border = 1
	The default border style for a map. More...

Protected Attributes
t_translation::ter_map	tiles_

starting_positions	starting_positions_

std::vector< map_location >	villages_

int	w_
	Sizes of the map area. More...

int	h_

Private Member Functions
t_translation::terrain_code &	operator[] (const map_location &loc)

int	read_header (const std::string &data)
	Reads the header of a map which is saved in the deprecated map_data format. More...

Private Attributes
std::shared_ptr< terrain_type_data >	tdata_

Detailed Description

Encapsulates the map of the game.

Although the game is hexagonal, the map is stored as a grid. Each type of terrain is represented by a multiletter terrain code.

Todo:: Update for new map-format.

Definition at line 33 of file map.hpp.

Member Typedef Documentation

◆ starting_positions

using gamemap::starting_positions = t_translation::starting_positions

Definition at line 217 of file map.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Maximum number of players supported.

Warning: when you increase this, you need to add more definitions to the team_colors.cfg file.

Enumerator
MAX_PLAYERS

Definition at line 208 of file map.hpp.

Constructor & Destructor Documentation

◆ gamemap()

gamemap::gamemap ( const std::string & data )

Loads a map.

Data should be a series of lines, with each character representing one hex on the map. Starting locations are represented by numbers.

Parameters

data	the map data to load.

Definition at line 104 of file map.cpp.

References DBG_G, game_config_manager::get(), read(), tdata_, and game_config_view::wrap().

Referenced by tdata().

◆ ~gamemap()

gamemap::~gamemap ( )

virtual

Definition at line 122 of file map.cpp.

Referenced by tdata().

Member Function Documentation

◆ border_size()

int gamemap::border_size ( ) const

inline

Size of the map border.

Definition at line 127 of file map.hpp.

References default_border.

Referenced by for_each_loc(), get_tiles_radius(), game_lua_kernel::intf_get_map_size(), editor::editor_map::mask_to(), on_board_with_border(), operator[](), parse_location_range(), read(), editor::editor_map::sanity_check(), and write().

◆ empty()

bool gamemap::empty ( ) const

inline

Tell if the map is of 0 size.

Definition at line 182 of file map.hpp.

References h_, and w_.

Referenced by team_builder::init().

◆ for_each_loc()

template<typename F >

void gamemap::for_each_loc ( const F & f ) const

inline

Definition at line 221 of file map.hpp.

References border_size(), f, h(), and w().

Referenced by preferences::encounter_map_terrain(), and editor::editor_map::resize().

◆ for_each_walkable_loc()

template<typename F >

void gamemap::for_each_walkable_loc ( const F & f ) const

inline

Definition at line 231 of file map.hpp.

References f, h(), and w().

Referenced by ai::default_recruitment::recruitment::compare_cost_maps_and_update_important_hexes().

◆ get_terrain()

t_translation::terrain_code gamemap::get_terrain ( const map_location & loc ) const

Looks up terrain at a particular location.

Hexes off the map may be looked up, and their 'emulated' terrain will also be returned. This allows proper drawing of the edges of the map.

Definition at line 314 of file map.cpp.

References t_translation::NONE_TERRAIN, map_location::null_location(), and on_board_with_border().

Referenced by terrain_builder::build_terrains(), ai::ai_default_rca::move_to_targets_phase::choose_move(), editor::mouse_action_paint::click_left(), editor::mouse_action_fill::click_left(), editor::mouse_action_paint::click_right(), editor::mouse_action_fill::click_right(), wfl::gamestate::DEFINE_WFL_FUNCTION(), editor::map_context::draw_terrain_actual(), preferences::encounter_map_terrain(), ai::ai_default_rca::get_villages_phase::find_villages(), footsteps_images(), editor::editor_map::get_contiguous_terrain_tiles(), get_terrain_editor_string(), get_terrain_info(), get_terrain_string(), gives_healing(), unit_animation_component::invalidate(), is_castle(), is_keep(), is_village(), editor::editor_map::mask_to(), unit_animation::matches(), ai::ai_default_rca::move_to_targets_phase::move_group(), operator[](), editor::editor_action_shuffle_area::perform_without_undo(), ai::ai_default_rca::move_to_targets_phase::rate_group(), ai::ai_default_rca::aspect_attacks_base::rate_terrain(), ai::default_ai_context_impl::rate_terrain(), unit_drawer::redraw_unit(), REPORT_GENERATOR(), set_terrain(), underlying_def_terrain(), underlying_mvt_terrain(), underlying_union_terrain(), unit_box_at(), and write_terrain().

◆ get_terrain_editor_string() [1/2]

std::string gamemap::get_terrain_editor_string ( const map_location & loc ) const

Definition at line 61 of file map.cpp.

References get_terrain().

Referenced by editor::terrain_palette::draw_item(), editor::editor_display::draw_sidebar(), and editor::terrain_palette::get_help_string().

◆ get_terrain_editor_string() [2/2]

std::string gamemap::get_terrain_editor_string ( const t_translation::terrain_code & terrain ) const

Definition at line 83 of file map.cpp.

References tdata_.

◆ get_terrain_info() [1/2]

const terrain_type & gamemap::get_terrain_info ( const t_translation::terrain_code & terrain ) const

Definition at line 96 of file map.cpp.

References tdata_.

Referenced by editor::terrain_palette::draw_item(), editor::map_context::draw_terrain(), editor::terrain_palette::get_id(), tod_manager::get_illuminated_time_of_day(), unit_animation_component::invalidate(), terrain_builder::rebuild_terrain(), unit_drawer::redraw_unit(), REPORT_GENERATOR(), editor::mouse_action::set_terrain_mouse_overlay(), editor::terrain_palette::setup(), events::menu_handler::terrain_description(), editor::editor_controller::terrain_description(), unit_box_at(), unit_defense(), unit_moves(), and villages().

◆ get_terrain_info() [2/2]

const terrain_type & gamemap::get_terrain_info ( const map_location & loc ) const

Shortcut to get_terrain_info(get_terrain(loc)).

Definition at line 48 of file map.cpp.

References get_terrain(), and tdata_.

◆ get_terrain_list()

const t_translation::ter_list & gamemap::get_terrain_list ( ) const

Gets the list of terrains.

Definition at line 42 of file map.cpp.

References tdata_.

Referenced by editor::terrain_palette::setup(), and villages().

◆ get_terrain_string() [1/2]

std::string gamemap::get_terrain_string ( const map_location & loc ) const

Definition at line 59 of file map.cpp.

References get_terrain().

Referenced by REPORT_GENERATOR().

◆ get_terrain_string() [2/2]

std::string gamemap::get_terrain_string ( const t_translation::terrain_code & terrain ) const

Definition at line 81 of file map.cpp.

References tdata_.

◆ get_underlying_terrain_string()

std::string gamemap::get_underlying_terrain_string ( const t_translation::terrain_code & terrain ) const

Definition at line 85 of file map.cpp.

References tdata_.

Referenced by REPORT_GENERATOR().

◆ gives_healing() [1/2]

int gamemap::gives_healing ( const map_location & loc ) const

Definition at line 66 of file map.cpp.

References get_terrain(), and on_board().

Referenced by ai::attack_analysis::analyze(), ai::ai_default_rca::aspect_attacks_base::rate_terrain(), and ai::default_ai_context_impl::rate_terrain().

◆ gives_healing() [2/2]

int gamemap::gives_healing ( const t_translation::terrain_code & terrain ) const

Definition at line 89 of file map.cpp.

References tdata_.

◆ h()

int gamemap::h ( ) const

inline

Effective map height, in hexes.

Definition at line 124 of file map.hpp.

References h_.

Referenced by ai::ai_default_rca::move_to_targets_phase::access_points(), display::bounds_check_position(), terrain_builder::build_terrains(), game_state::can_recruit_on(), ai::ai_default_rca::move_to_targets_phase::choose_move(), actions::shroud_clearer::clear_loc(), events::menu_handler::do_search(), display::draw_minimap(), display::draw_minimap_units(), ai::ai_default_rca::goto_phase::evaluate(), ai::ai_default_rca::move_leader_to_goals_phase::evaluate(), ai::ai_default_rca::move_leader_to_keep_phase::evaluate(), actions::find_recruit_location(), pathfind::find_routes(), ai::default_ai_context_impl::find_targets(), for_each_loc(), for_each_walkable_loc(), pathfind::full_cost_map::full_cost_map(), mp::game_info::game_info(), ai::keeps_cache::get(), pathfind::full_cost_map::get_pair_at(), events::mouse_handler::get_route(), get_tiles_radius(), image::getMinimap(), game_lua_kernel::intf_find_path(), game_lua_kernel::intf_get_map_size(), editor::editor_map::invert_selection(), editor::editor_map::mask_to(), display::max_map_area(), display::minimap_location_on(), editor::context_manager::new_map_dialog(), editor::context_manager::new_scenario_dialog(), parse_location_range(), terrain_builder::rebuild_cache_all(), editor::editor_map::resize(), editor::context_manager::resize_map_dialog(), editor::editor_map::same_size_as(), editor::editor_map::sanity_check(), editor::map_context::set_map(), ai::move_result::test_route(), and ai::default_recruitment::recruitment::update_average_local_cost().

◆ is_castle() [1/2]

bool gamemap::is_castle ( const map_location & loc ) const

Definition at line 68 of file map.cpp.

References get_terrain(), and on_board().

Referenced by game_state::can_recruit_on(), pathfind::find_vacant_tile(), ai::keeps_cache::get(), actions::get_recalls(), actions::get_recruits(), and play_controller::hotkey_handler::in_context_menu().

◆ is_castle() [2/2]

bool gamemap::is_castle ( const t_translation::terrain_code & terrain ) const

Definition at line 91 of file map.cpp.

References tdata_.

◆ is_keep() [1/2]

bool gamemap::is_keep ( const map_location & loc ) const

Definition at line 70 of file map.cpp.

References get_terrain(), and on_board().

Referenced by game_state::can_recruit_from(), game_state::can_recruit_on(), ai::keeps_cache::get(), actions::get_recalls(), actions::get_recruits(), play_controller::hotkey_handler::in_context_menu(), and events::mouse_handler::move_unit_along_route().

◆ is_keep() [2/2]

bool gamemap::is_keep ( const t_translation::terrain_code & terrain ) const

Definition at line 93 of file map.cpp.

References tdata_.

◆ is_starting_position()

const std::string * gamemap::is_starting_position ( const map_location & loc ) const

returns the side number of the side starting at position loc, 0 if no such side exists.

Definition at line 354 of file map.cpp.

References starting_positions_.

Referenced by editor::mouse_action::key_event(), operator[](), editor::editor_action_starting_position::perform_without_undo(), editor::mouse_action_starting_position::up_left(), and editor::mouse_action_starting_position::up_right().

◆ is_village() [1/2]

bool gamemap::is_village ( const map_location & loc ) const

◆ is_village() [2/2]

bool gamemap::is_village ( const t_translation::terrain_code & terrain ) const

Definition at line 87 of file map.cpp.

References tdata_.

◆ num_valid_starting_positions()

int gamemap::num_valid_starting_positions ( ) const

Definition at line 341 of file map.cpp.

References c, and starting_positions_.

Referenced by operator[](), and game_state::place_sides_in_preferred_locations().

◆ on_board()

bool gamemap::on_board ( const map_location & loc ) const

Tell if a location is on the map.

Should be called before indexing using [].

Todo:: inline for performance? – Ilor

Definition at line 382 of file map.cpp.

References h_, map_location::valid(), w_, map_location::x, and map_location::y.

◆ on_board_with_border()

bool gamemap::on_board_with_border ( const map_location & loc ) const

◆ operator[]() [1/2]

const t_translation::terrain_code gamemap::operator[] ( const map_location & loc ) const

inline

Definition at line 135 of file map.hpp.

References border_size(), t_translation::ter_map::get(), tiles_, map_location::x, and map_location::y.

◆ operator[]() [2/2]

t_translation::terrain_code& gamemap::operator[] ( const map_location & loc )

inlineprivate

Definition at line 141 of file map.hpp.

References border_size(), t_translation::ter_map::get(), get_terrain(), is_starting_position(), num_valid_starting_positions(), on_board(), on_board_with_border(), set_special_location(), set_starting_position(), special_location(), starting_position(), tiles_, write_terrain(), map_location::x, and map_location::y.

◆ overlay()

void gamemap::overlay	(	const gamemap &	m,
		map_location	loc,
		const std::vector< overlay_rule > &	rules = `std::vector<overlay_rule>()`,
		bool	is_odd = `false`,
		bool	ignore_special_locations = `false`
	)

Overlays another map onto this one at the given position.

Definition at line 215 of file map.cpp.

References overlay_impl(), starting_positions_, and tiles_.

Referenced by gamemap::overlay_rule::overlay_rule().

◆ overlay_impl()

void gamemap::overlay_impl	(	const t_translation::ter_map &	m1,
		t_translation::starting_positions &	m1_st,
		const t_translation::ter_map &	m2,
		const t_translation::starting_positions &	m2_st,
		std::function< void(const map_location &, const t_translation::terrain_code &, terrain_type_data::merge_mode, bool)>	set_terrain,
		map_location	loc,
		const std::vector< overlay_rule > &	rules,
		bool	is_odd,
		bool	ignore_special_locations
	)

static

◆ parse_location_range()

std::vector< map_location > gamemap::parse_location_range	(	const std::string &	xvals,
		const std::string &	yvals,
		bool	with_border = `false`
	)		const

Parses ranges of locations into a vector of locations, using this map's dimensions as bounds.

Definition at line 421 of file map.cpp.

References border_size(), h(), i, utils::parse_range(), utils::split(), and w().

Referenced by tod_manager::add_time_area(), and team::build().

◆ read()

void gamemap::read	(	const std::string &	data,
		const bool	allow_invalid = `true`
	)

Definition at line 126 of file map.cpp.

References border_size(), e, t_translation::ter_map::get(), h_, game::error::message, t_translation::read_game_map(), read_header(), starting_positions_, t, tdata_, tiles_, total_height(), total_width(), villages_, w_, and t_translation::write_terrain_code().

Referenced by gamemap(), game_lua_kernel::intf_terrain_mask(), read_header(), tdata(), and game_events::WML_HANDLER_FUNCTION().

◆ read_header()

int gamemap::read_header ( const std::string & data )

private

Reads the header of a map which is saved in the deprecated map_data format.

Parameters

data	The mapdata to load.

Definition at line 183 of file map.cpp.

References read().

Referenced by read().

◆ set_special_location()

void gamemap::set_special_location	(	const std::string &	id,
		const map_location &	loc
	)

Definition at line 360 of file map.cpp.

References starting_positions_, and map_location::valid().

Referenced by operator[](), editor::editor_action_starting_position::perform_without_undo(), and set_starting_position().

◆ set_starting_position()

void gamemap::set_starting_position	(	int	side,
		const map_location &	loc
	)

Manipulate starting positions of the different sides.

Definition at line 377 of file map.cpp.

References set_special_location().

Referenced by operator[](), and game_state::place_sides_in_preferred_locations().

◆ set_terrain()

void gamemap::set_terrain	(	const map_location &	loc,
		const t_translation::terrain_code &	terrain,
		const terrain_type_data::merge_mode	mode = `terrain_type_data::BOTH`,
		bool	replace_if_failed = `false`
	)