gui2::dialogs::mp_join_game Class Reference

#include <mp_join_game.hpp>

Inheritance diagram for gui2::dialogs::mp_join_game:

Public Member Functions
	mp_join_game (saved_game &state, wesnothd_connection &connection, const bool first_scenario=true, const bool observe_game=false)
	~mp_join_game ()
bool	fetch_game_config ()
bool	started () const
Public Member Functions inherited from gui2::dialogs::modal_dialog
	modal_dialog ()
virtual	~modal_dialog ()
bool	show (const unsigned auto_close_time=0)
	Shows the window. More...
window *	get_window () const
	Returns a pointer to the dialog's window. More...
int	get_retval () const
	Returns the cached window exit code. More...
void	set_retval (int retval)
	Convenience wrapper to set the window's exit code. More...
void	set_always_save_fields (const bool always_save_fields)
void	set_restore (const bool restore)
void	set_allow_plugin_skip (const bool allow_plugin_skip)
void	set_show_even_without_video (const bool show_even_without_video)

Private Member Functions
virtual const std::string &	window_id () const override
	The id of the window to build. More...
virtual void	pre_show (window &window) override
	Actions to be taken before showing the window. More...
virtual void	post_show (window &window) override
	Actions to be taken after the window has been shown. More...
bool	show_flg_select (int side_num, bool first_time=false)
void	generate_side_list ()
void	close_faction_select_dialog_if_open ()
	Will close the Faction Select dialog if it's open. More...
void	network_handler ()
config &	get_scenario ()
Private Member Functions inherited from gui2::dialogs::plugin_executor
	plugin_executor ()
	~plugin_executor ()

Private Attributes
config	level_
saved_game &	state_
wesnothd_connection &	network_connection_
std::size_t	update_timer_
const bool	first_scenario_
bool	observe_game_
bool	stop_updates_
std::map< std::string, tree_view_node * >	team_tree_map_
std::unique_ptr< player_list_helper >	player_list_
faction_select *	flg_dialog_
Private Attributes inherited from gui2::dialogs::plugin_executor
std::unique_ptr< plugins_context >	plugins_context_

Additional Inherited Members
Protected Member Functions inherited from gui2::dialogs::modal_dialog
field_bool *	register_bool (const std::string &id, const bool mandatory, const std::function< bool()> callback_load_value=nullptr, const std::function< void(bool)> callback_save_value=nullptr, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
	Creates a new boolean field. More...
field_bool *	register_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
	Creates a new boolean field. More...
field_integer *	register_integer (const std::string &id, const bool mandatory, const std::function< int()> callback_load_value=nullptr, const std::function< void(int)> callback_save_value=nullptr)
	Creates a new integer field. More...
field_integer *	register_integer (const std::string &id, const bool mandatory, int &linked_variable)
	Creates a new integer field. More...
field_text *	register_text (const std::string &id, const bool mandatory, const std::function< std::string()> callback_load_value=nullptr, const std::function< void(const std::string &)> callback_save_value=nullptr, const bool capture_focus=false)
	Creates a new text field. More...
field_text *	register_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
	Creates a new text field. More...
field_label *	register_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
	Registers a new styled_widget as a label. More...
field_label *	register_image (const std::string &id, const bool mandatory, const std::string &filename)
	Registers a new styled_widget as image. More...
Protected Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< window >	window_
	The window object build for this dialog. More...

Detailed Description

Definition at line 33 of file mp_join_game.hpp.

Constructor & Destructor Documentation

mp_join_game()

gui2::dialogs::mp_join_game::mp_join_game	(	saved_game &	state,
		wesnothd_connection &	connection,
		const bool	first_scenario = true,
		const bool	observe_game = false
	)

Definition at line 61 of file mp_join_game.cpp.

~mp_join_game()

gui2::dialogs::mp_join_game::~mp_join_game

(

)

Definition at line 75 of file mp_join_game.cpp.

References gui2::remove_timer(), and update_timer_.

Member Function Documentation

close_faction_select_dialog_if_open()

void gui2::dialogs::mp_join_game::close_faction_select_dialog_if_open ( )

private

Will close the Faction Select dialog if it's open.

This is used in network_handler to dismiss the dialog if certain actions occur, such as the game starting.

Todo:

maybe move this to a general-purpose close() function in modal_dialog and modeless_dialog? It could be useful.

Definition at line 475 of file mp_join_game.cpp.

References gui2::CANCEL, flg_dialog_, gui2::dialogs::modal_dialog::get_window(), and w.

Referenced by network_handler(), and started().

fetch_game_config()

bool gui2::dialogs::mp_join_game::fetch_game_config

(

)

Definition at line 86 of file mp_join_game.cpp.

References game_config::add_color_info(), config::child(), saved_game::classification(), saved_game::clear(), gui2::dialogs::loading_screen::display(), download_level_data, lg::err(), first_scenario_, game_config_manager::get(), get_scenario(), saved_game::get_scenario_id(), config::has_attribute(), utf8::index(), level_, mp::level_to_gamestate(), game_config_manager::load_game_config_for_game(), preferences::login(), network_connection_, next_scenario, observe_game_, gui2::dialogs::loading_screen::progress(), wesnothd_connection::send_data(), show_flg_select(), state_, config::swap(), wesnothd_connection::wait_and_receive_data(), and game_config_view::wrap().

generate_side_list()

void gui2::dialogs::mp_join_game::generate_side_list ( )

private

Definition at line 335 of file mp_join_game.cpp.

References _(), gui2::tree_view::add_node(), gui2::tree_view_node::add_sibling(), config::child_range(), gui2::tree_view::clear(), gui2::event::connect_signal_mouse_left_click(), unit_type_data::find(), unit_type::flag_rgb(), t_string::from_serialized(), gui2::dialogs::generate_user_description(), gui2::tree_view_node::get_grid(), font::get_pango_color_from_id(), get_scenario(), gui2::dialogs::modal_dialog::get_window(), gui2::widget::hidden, unit_type::image(), gui2::widget::invisible, preferences::login(), ng::random_enemy_picture(), show_flg_select(), stop_updates_, team_tree_map_, unit_type::type_name(), and unit_types.

Referenced by network_handler(), pre_show(), and started().

get_scenario()

config & gui2::dialogs::mp_join_game::get_scenario ( )

private

Definition at line 550 of file mp_join_game.cpp.

References config::child(), and level_.

Referenced by fetch_game_config(), generate_side_list(), network_handler(), pre_show(), show_flg_select(), and started().

network_handler()

void gui2::dialogs::mp_join_game::network_handler ( )

private

Definition at line 484 of file mp_join_game.cpp.

References _(), config::apply_diff(), c, gui2::CANCEL, config::child(), config::child_range(), close_faction_select_dialog_if_open(), ERR_MP, config::find_child(), first_scenario_, flg_dialog_, generate_side_list(), get_scenario(), gui2::dialogs::faction_select::get_side_num(), gui2::dialogs::modal_dialog::get_window(), config::has_child(), level_, network_connection_, gui2::OK, player_list_, wesnothd_connection::receive_data(), gui2::dialogs::modal_dialog::set_retval(), gui2::show_transient_message(), and stop_updates_.

Referenced by pre_show(), and started().

post_show()

void gui2::dialogs::mp_join_game::post_show ( window &  window )

overrideprivatevirtual

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the OK has been pressed).

Parameters

window

The window which has been shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 561 of file mp_join_game.cpp.

References config::child(), statistics::fresh_stats(), mp_ui_alerts::game_has_begun(), gui2::window::get_retval(), level_, mp::level_to_gamestate(), preferences::login(), network_connection_, observe_game_, gui2::OK, statistics::read_stats(), gui2::remove_timer(), wesnothd_connection::send_data(), state_, and update_timer_.

Referenced by started().

pre_show()

void gui2::dialogs::mp_join_game::pre_show ( window &  window )

overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Parameters

window

The window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 223 of file mp_join_game.cpp.

References gui2::chatbox::active_window_changed(), gui2::add_timer(), gui2::CANCEL, config::child(), default_chat_log, generate_side_list(), get_scenario(), level_, gui2::chatbox::load_log(), game_config::lobby_network_timer, N_, network_connection_, network_handler(), gui2::OK, player_list_, gui2::dialogs::plugin_executor::plugins_context_, gui2::chatbox::room_window_open(), gui2::chatbox::send_chat_message(), gui2::window::set_enter_disabled(), gui2::window::set_escape_disabled(), gui2::styled_widget::set_label(), gui2::chatbox::set_wesnothd_connection(), font::unicode_em_dash, and update_timer_.

Referenced by started().

show_flg_select()

bool gui2::dialogs::mp_join_game::show_flg_select ( int  side_num, bool  first_time = false  )

private

Returns

false if an error ocurred.

Definition at line 271 of file mp_join_game.cpp.

References config::add_child(), config::child(), config::child_range(), saved_game::classification(), preferences::era(), ERR_MP, flg_dialog_, get_scenario(), game_classification::is_normal_mp_game(), level_, preferences::login(), network_connection_, gui2::NONE, ON_SCOPE_EXIT, wesnothd_connection::send_data(), gui2::dialogs::modal_dialog::show(), state_, preferences::use_map_settings(), and WRN_MP.

Referenced by fetch_game_config(), generate_side_list(), and started().

started()

bool gui2::dialogs::mp_join_game::started ( ) const

inline

Definition at line 42 of file mp_join_game.hpp.

References close_faction_select_dialog_if_open(), generate_side_list(), get_scenario(), level_, network_handler(), post_show(), pre_show(), show_flg_select(), and window_id().

window_id()

virtual const std::string& gui2::dialogs::mp_join_game::window_id ( ) const

overrideprivatevirtual

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Referenced by started().

Member Data Documentation

first_scenario_

const bool gui2::dialogs::mp_join_game::first_scenario_

private

Definition at line 78 of file mp_join_game.hpp.

Referenced by fetch_game_config(), and network_handler().

flg_dialog_

faction_select* gui2::dialogs::mp_join_game::flg_dialog_

private

Definition at line 87 of file mp_join_game.hpp.

Referenced by close_faction_select_dialog_if_open(), network_handler(), and show_flg_select().

level_

config gui2::dialogs::mp_join_game::level_

private

Definition at line 70 of file mp_join_game.hpp.

Referenced by fetch_game_config(), get_scenario(), network_handler(), post_show(), pre_show(), show_flg_select(), and started().

network_connection_

wesnothd_connection& gui2::dialogs::mp_join_game::network_connection_

private

Definition at line 74 of file mp_join_game.hpp.

Referenced by fetch_game_config(), network_handler(), post_show(), pre_show(), and show_flg_select().

observe_game_

bool gui2::dialogs::mp_join_game::observe_game_

private

Definition at line 80 of file mp_join_game.hpp.

Referenced by fetch_game_config(), and post_show().

player_list_

std::unique_ptr<player_list_helper> gui2::dialogs::mp_join_game::player_list_

private

Definition at line 85 of file mp_join_game.hpp.

Referenced by network_handler(), and pre_show().

state_

saved_game& gui2::dialogs::mp_join_game::state_

private

Definition at line 72 of file mp_join_game.hpp.

Referenced by fetch_game_config(), post_show(), and show_flg_select().

stop_updates_

bool gui2::dialogs::mp_join_game::stop_updates_

private

Definition at line 81 of file mp_join_game.hpp.

Referenced by generate_side_list(), and network_handler().

team_tree_map_

std::map<std::string, tree_view_node*> gui2::dialogs::mp_join_game::team_tree_map_

private

Definition at line 83 of file mp_join_game.hpp.

Referenced by generate_side_list().

update_timer_

std::size_t gui2::dialogs::mp_join_game::update_timer_

private

Definition at line 76 of file mp_join_game.hpp.

Referenced by post_show(), pre_show(), and ~mp_join_game().

---

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

• gui/dialogs/multiplayer/mp_join_game.hpp
• gui/dialogs/multiplayer/mp_join_game.cpp