display_context Class Reference

#include <display_context.hpp>

Inheritance diagram for display_context:

Public Member Functions
virtual const std::vector< team > &	teams () const =0
virtual const gamemap &	map () const =0
virtual const unit_map &	units () const =0
virtual const std::vector< std::string > &	hidden_label_categories () const =0
std::vector< std::string > &	hidden_label_categories_ref ()
const team &	get_team (int side) const
template<typename T = void>
bool	has_team (int side) const
bool	would_be_discovered (const map_location &loc, int side_num, bool see_all=true)
	Given a location and a side number, indicates whether an invisible unit of that side at that location would be revealed (perhaps ambushed), based on what team side_num can see. More...
const unit *	get_visible_unit (const map_location &loc, const team &current_team, bool see_all=false) const
bool	unit_can_move (const unit &u) const
	Will return true iff the unit u has any possible moves it can do (including attacking etc). More...
int	village_owner (const map_location &loc) const
	Given the location of a village, will return the 0-based index of the team that currently owns it, and -1 if it is unowned. More...
int	side_units (int side_num) const
	Returns the number of units of the side side_num. More...
int	side_units_cost (int side_num) const
	Returns the total cost of units of side side_num. More...
int	side_upkeep (int side_num) const
team_data	calculate_team_data (const class team &tm) const
bool	is_observer () const
	Check if we are an observer in this game. More...
virtual	~display_context ()

Detailed Description

Definition at line 51 of file display_context.hpp.

Constructor & Destructor Documentation

~display_context()

virtual display_context::~display_context ( )

inlinevirtual

Definition at line 111 of file display_context.hpp.

Member Function Documentation

calculate_team_data()

team_data display_context::calculate_team_data

(

const class team &

tm

)

const

Definition at line 162 of file display_context.cpp.

References team_data::expenses, team_data::gold, team::gold(), team_data::net_income, team::side(), side_units(), side_upkeep(), team::support(), team_data::teamname, team::total_income(), team_data::units, team_data::upkeep, team::user_team_name(), team_data::villages, and team::villages().

Referenced by impl_side_get().

get_team()

const team & display_context::get_team

(

int

side

)

const

Definition at line 27 of file display_context.cpp.

References teams().

Referenced by unit::ability_active(), gui2::dialogs::add_unit_entry(), attack_info(), gui2::dialogs::gamestate_inspector::controller::build_stuff_list(), events::menu_handler::goto_leader(), side_filter::match(), side_filter::match_internal(), terrain_filter::match_internal(), game_display::scroll_to_leader(), gui2::dialogs::team_mode_controller::show_list(), gui2::dialogs::team_mode_controller::show_recall(), gui2::dialogs::team_mode_controller::show_recall_unit(), attack_type::special_active(), game_board::teams(), unit_can_move(), unit_display::unit_recruited(), unit_side(), and would_be_discovered().

get_visible_unit()

const unit * display_context::get_visible_unit	(	const map_location &	loc,
		const team &	current_team,
		bool	see_all = false
	)		const

Definition at line 58 of file display_context.cpp.

References unit_map::find(), map(), units(), and unit_map::iterator_base< iter_types >::valid().

Referenced by get_selected_unit(), and get_visible_unit().

has_team()

template<typename T = void>

bool display_context::has_team ( int  side ) const

inline

Definition at line 62 of file display_context.hpp.

References get_visible_unit().

hidden_label_categories()

virtual const std::vector<std::string>& display_context::hidden_label_categories ( ) const

pure virtual

Implemented in editor::map_context, game_board, and pathfind::ignore_units_display_context.

Referenced by terrain_label::hidden(), and hidden_label_categories_ref().

hidden_label_categories_ref()

std::vector< std::string > & display_context::hidden_label_categories_ref

(

)

Definition at line 23 of file display_context.cpp.

References hidden_label_categories().

Referenced by gui2::dialogs::label_settings::execute(), and game_state::init().

is_observer()

bool display_context::is_observer

(

)

const

Check if we are an observer in this game.

Determine if we are an observer, by checking if every team is not locally controlled.

Definition at line 123 of file display_context.cpp.

References t, and teams().

Referenced by display_chat_manager::add_chat_message(), events::menu_handler::clear_labels(), events::menu_handler::send_chat_message(), events::menu_handler::speak(), and terrain_label::viewable().

map()

virtual const gamemap& display_context::map ( ) const

pure virtual

Implemented in editor::map_context, game_board, and pathfind::ignore_units_display_context.

Referenced by game_display::draw_footstep_images(), terrain_filterimpl::filter_special_loc(), terrain_filterimpl::filter_xy(), editor::map_context::get_labels(), terrain_filter::get_locs_impl(), get_visible_unit(), terrain_filter::match_impl(), terrain_filter::match_internal(), gui2::dialogs::game_stats::pre_show(), and unit_can_move().

side_units()

int display_context::side_units

(

int

side_num

)

const

Returns the number of units of the side side_num.

Static info getters previously declared at global scope in unit.?pp.

Definition at line 135 of file display_context.cpp.

References units().

Referenced by calculate_team_data(), and ai_testing::log_turn().

side_units_cost()

int display_context::side_units_cost

(

int

side_num

)

const

Returns the total cost of units of side side_num.

Definition at line 144 of file display_context.cpp.

References units().

Referenced by ai_testing::log_turn().

side_upkeep()

int display_context::side_upkeep

(

int

side_num

)

const

Definition at line 153 of file display_context.cpp.

References units().

Referenced by calculate_team_data(), play_controller::do_init_side(), and ai::default_recruitment::recruitment::get_estimated_income().

teams()

virtual const std::vector<team>& display_context::teams ( ) const

pure virtual

Implemented in editor::map_context, game_board, and pathfind::ignore_units_display_context.

Referenced by gui2::dialogs::gamestate_inspector::controller::build_stuff_list(), game_display::current_team_name(), game_display::display_unit_hex(), game_display::draw_hex_cursor(), game_display::draw_movement_info(), gui2::dialogs::game_stats::execute(), editor::editor_display::get_clip_rect(), editor::map_context::get_labels(), get_team(), side_filter::get_teams(), game_display::highlight_hex(), display::init_flags(), is_observer(), gui2::dialogs::label_settings::pre_show(), gui2::dialogs::game_stats::pre_show(), and village_owner().

unit_can_move()

bool display_context::unit_can_move

(

const unit &

u

)

const

Will return true iff the unit u has any possible moves it can do (including attacking etc).

Definition at line 73 of file display_context.cpp.

References unit::attacks_left(), unit_map::find(), get_adjacent_tiles(), unit::get_location(), get_team(), unit::has_goto(), unit::has_moved(), i, team::is_enemy(), map(), unit::movement_cost(), unit::movement_left(), n, gamemap::on_board(), unit::side(), units(), and unit_map::iterator_base< iter_types >::valid().

Referenced by unit_drawer::redraw_unit(), events::mouse_handler::unit_in_cycle(), and events::menu_handler::update_shroud_now().

units()

virtual const unit_map& display_context::units ( ) const

pure virtual

Implemented in editor::map_context, game_board, and pathfind::ignore_units_display_context.

Referenced by unit_filter::all_matches_on_map(), game_display::draw_footstep_images(), game_display::draw_movement_info(), unit_filter::first_match_on_map(), editor::map_context::get_labels(), gui2::dialogs::game_stats::get_leader(), terrain_filter::get_locs_impl(), get_visible_unit(), game_display::highlight_hex(), terrain_filter::match_impl(), side_filter::match_internal(), terrain_filter::match_internal(), game_display::scroll_to_leader(), gui2::dialogs::unit_mode_controller::show_list(), gui2::dialogs::unit_mode_controller::show_unit(), gui2::dialogs::team_mode_controller::show_units(), side_units(), side_units_cost(), side_upkeep(), unit_can_move(), and would_be_discovered().

village_owner()

int display_context::village_owner

(

const map_location &

loc

)

const

Given the location of a village, will return the 0-based index of the team that currently owns it, and -1 if it is unowned.

Definition at line 110 of file display_context.cpp.

References i, t, and teams().

Referenced by events::menu_handler::change_side(), game_board::change_terrain(), terrain_filter::match_internal(), ai::ai_default_rca::aspect_attacks_base::rate_terrain(), ai::default_ai_context_impl::rate_terrain(), image::render_minimap(), and game_board::replace_map().

would_be_discovered()

bool display_context::would_be_discovered	(	const map_location &	loc,
		int	side_num,
		bool	see_all = true
	)

Given a location and a side number, indicates whether an invisible unit of that side at that location would be revealed (perhaps ambushed), based on what team side_num can see.

If see_all is true then the calculation ignores fog, and enemy ambushers.

Definition at line 32 of file display_context.cpp.

References unit_map::find(), team::fogged(), get_adjacent_tiles(), get_team(), unit::incapacitated(), unit::invisible(), team::is_enemy(), unit::side(), units(), and unit_map::iterator_base< iter_types >::valid().

Referenced by unit::invisible().

---

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

• display_context.hpp
• display_context.cpp