The Battle for Wesnoth  1.19.5+dev
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
gui2::dialogs::mp_lobby Class Reference

#include <lobby.hpp>

Inheritance diagram for gui2::dialogs::mp_lobby:

Public Types

enum  lobby_result {
  QUIT , JOIN , OBSERVE , CREATE ,
  RELOAD_CONFIG
}
 
- Public Types inherited from gui2::window
enum class  status { NEW , SHOWING , REQUEST_CLOSE , CLOSED }
 The status of the window. More...
 
enum class  exit_hook { on_all , on_ok }
 
enum class  show_mode { none , modal , modeless , tooltip }
 
- Public Types inherited from gui2::widget
enum class  visibility { visible , hidden , invisible }
 Visibility settings done by the user. More...
 
enum class  redraw_action { full , partly , none }
 Visibility set by the engine. More...
 
enum class  debug_border { none , outline , fill }
 
- Public Types inherited from gui2::event::dispatcher
enum  event_queue_type { pre = 1 , child = 2 , post = 4 }
 
enum  queue_position {
  front_pre_child , back_pre_child , front_child , back_child ,
  front_post_child , back_post_child
}
 The position where to add a new callback in the signal handler. More...
 
enum class  mouse_behavior { all , hit , none }
 The behavior of the mouse events. More...
 

Public Member Functions

 mp_lobby (mp::lobby_info &info, wesnothd_connection &connection, int &joined_game)
 
 ~mp_lobby ()
 
void update_gamelist ()
 
void update_playerlist ()
 
- Public Member Functions inherited from gui2::dialogs::modal_dialog
 modal_dialog (const std::string &window_id)
 
virtual ~modal_dialog ()
 
bool show (const unsigned auto_close_time=0)
 Shows the window. More...
 
int get_retval () const
 Returns the cached window exit code. More...
 
void set_always_save_fields (const bool always_save_fields)
 
void set_allow_plugin_skip (const bool allow_plugin_skip)
 
void set_show_even_without_video (const bool show_even_without_video)
 
- Public Member Functions inherited from gui2::window
 window (const builder_window::window_resolution &definition)
 < Needs to be initialized in show. More...
 
virtual ~window ()
 
int show (unsigned auto_close_timeout=0)
 Shows the window, running an event loop until it should close. More...
 
void show_tooltip ()
 Shows the window as a tooltip. More...
 
void show_non_modal ()
 Shows the window non modal. More...
 
void draw ()
 Draws the window. More...
 
void hide ()
 Hides the window. More...
 
virtual void layout () override
 Lays out the window. More...
 
virtual void render () override
 Ensure the window's internal render buffer is up-to-date. More...
 
virtual bool expose (const rect &region) override
 Called by draw_manager when it believes a redraw is necessary. More...
 
virtual rect screen_location () override
 The current draw location of the window, on the screen. More...
 
void queue_rerender (const rect &region)
 Queue a rerender of the internal render buffer. More...
 
void queue_rerender ()
 
void defer_region (const rect &region)
 Defer rendering of a particular region to next frame. More...
 
void close ()
 Requests to close the window. More...
 
bool invalidate_layout_blocked () const
 Is invalidate_layout blocked, see invalidate_layout_blocker. More...
 
void invalidate_layout ()
 Updates the size of the window. More...
 
virtual widgetfind_at (const point &coordinate, const bool must_be_active) override
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override
 See widget::find_at. More...
 
dialogs::modal_dialogdialog ()
 Inherited from widget. More...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string &id, const bool must_be_active) const override
 See widget::find. More...
 
bool does_click_dismiss () const
 Does the window close easily? More...
 
void set_enter_disabled (const bool enter_disabled)
 Disable the enter key. More...
 
void set_escape_disabled (const bool escape_disabled)
 Disable the escape key. More...
 
void init_linked_size_group (const std::string &id, const bool fixed_width, const bool fixed_height)
 Initializes a linked size group. More...
 
bool has_linked_size_group (const std::string &id)
 Is the linked size group defined for this window? More...
 
void add_linked_widget (const std::string &id, widget *widget)
 Adds a widget to a linked size group. More...
 
void remove_linked_widget (const std::string &id, const widget *widget)
 Removes a widget from a linked size group. More...
 
void set_retval (const int retval, const bool close_window=true)
 Sets there return value of the window. More...
 
int get_retval ()
 
void set_owner (dialogs::modal_dialog *owner)
 
void set_click_dismiss (const bool click_dismiss)
 
bool get_need_layout () const
 
void set_variable (const std::string &key, const wfl::variant &value)
 
point get_linked_size (const std::string &linked_group_id) const
 
void set_exit_hook (exit_hook mode, std::function< bool(window &)> func)
 Sets the window's exit hook. More...
 
const event::distributorget_distributor () const
 Gets a reference to the window's distributor to allow some state peeking. More...
 
show_mode mode () const
 Returns the dialog mode for this window. More...
 
void mouse_capture (const bool capture=true)
 
void keyboard_capture (widget *widget)
 
void add_to_keyboard_chain (widget *widget)
 Adds the widget to the keyboard chain. More...
 
void remove_from_keyboard_chain (widget *widget)
 Remove the widget from the keyboard chain. More...
 
void add_to_tab_order (widget *widget, int at=-1)
 Add the widget to the tabbing order. More...
 
- Public Member Functions inherited from gui2::panel
 panel (const implementation::builder_styled_widget &builder, const std::string &control_type="")
 Constructor. More...
 
virtual SDL_Rect get_client_rect () const override
 See container_base::get_client_rect. More...
 
virtual bool get_active () const override
 See styled_widget::get_active. More...
 
virtual unsigned get_state () const override
 See styled_widget::get_state. More...
 
- Public Member Functions inherited from gui2::container_base
 container_base (const implementation::builder_styled_widget &builder, const std::string &control_type)
 
virtual void layout_initialize (const bool full_initialization) override
 See widget::layout_initialize. More...
 
void reduce_width (const unsigned maximum_width)
 Tries to reduce the width of a container. More...
 
virtual void request_reduce_width (const unsigned maximum_width) override
 See widget::request_reduce_width. More...
 
virtual void demand_reduce_width (const unsigned maximum_width) override
 See widget::demand_reduce_width. More...
 
void reduce_height (const unsigned maximum_height)
 Tries to reduce the height of a container. More...
 
virtual void request_reduce_height (const unsigned maximum_height) override
 See widget::request_reduce_height. More...
 
virtual void demand_reduce_height (const unsigned maximum_height) override
 See widget::demand_reduce_height. More...
 
virtual bool can_wrap () const override
 See widget::can_wrap. More...
 
virtual void place (const point &origin, const point &size) override
 See widget::place. More...
 
virtual bool has_widget (const widget &widget) const override
 See widget::has_widget. More...
 
virtual void set_origin (const point &origin) override
 See widget::set_origin. More...
 
virtual void set_visible_rectangle (const SDL_Rect &rectangle) override
 See widget::set_visible_rectangle. More...
 
virtual void impl_draw_children () override
 See widget::impl_draw_children. More...
 
virtual void set_active (const bool active) override
 See styled_widget::set_active. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
virtual iteration::walker_ptr create_walker () override
 See widget::create_walker. More...
 
void init_grid (const builder_grid &grid_builder)
 Initializes and builds the grid. More...
 
grid::iterator begin ()
 
grid::iterator end ()
 
unsigned add_row (const unsigned count=1)
 
void set_rows (const unsigned rows)
 
unsigned int get_rows () const
 
void set_cols (const unsigned cols)
 
unsigned int get_cols () const
 
void set_rows_cols (const unsigned rows, const unsigned cols)
 
void set_child (std::unique_ptr< widget > widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)
 
void set_row_grow_factor (const unsigned row, const unsigned factor)
 
void set_column_grow_factor (const unsigned column, const unsigned factor)
 
const gridget_grid () const
 
gridget_grid ()
 
- Public Member Functions inherited from gui2::styled_widget
 styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type)
 Constructor. More...
 
virtual void set_members (const widget_item &data)
 Sets the members of the styled_widget. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
point get_config_minimum_size () const
 Gets the minimum size as defined in the config. More...
 
point get_config_default_size () const
 Gets the default size as defined in the config. More...
 
point get_config_maximum_size () const
 Gets the best size as defined in the config. More...
 
virtual unsigned get_characters_per_line () const
 Returns the number of characters per line. More...
 
virtual bool get_link_aware () const
 Returns whether the label should be link_aware, in in rendering and in searching for links with get_link. More...
 
virtual color_t get_link_color () const
 Returns the color string to be used with links. More...
 
bool get_use_tooltip_on_label_overflow () const
 
void set_use_tooltip_on_label_overflow (const bool use_tooltip=true)
 
const t_stringget_label () const
 
virtual void set_label (const t_string &text)
 
virtual void set_use_markup (bool use_markup)
 
bool get_use_markup () const
 
const t_stringtooltip () const
 
void set_tooltip (const t_string &tooltip)
 
const t_stringhelp_message () const
 
void set_help_message (const t_string &help_message)
 
std::vector< canvas > & get_canvases ()
 
canvasget_canvas (const unsigned index)
 
virtual void set_text_alignment (const PangoAlignment text_alignment)
 
PangoAlignment get_text_alignment () const
 
void set_text_ellipse_mode (const PangoEllipsizeMode ellipse_mode)
 
PangoEllipsizeMode get_text_ellipse_mode () const
 Get the text's ellipsize mode. More...
 
void set_text_maximum_width (int max_width)
 Set how wide the text can become. More...
 
- Public Member Functions inherited from gui2::widget
 widget (const widget &)=delete
 
widgetoperator= (const widget &)=delete
 
 widget ()
 
 widget (const builder_widget &builder)
 Constructor. More...
 
virtual ~widget () override
 
void set_id (const std::string &id)
 
const std::string & id () const
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
const gridget_parent_grid () const
 
void set_parent (widget *parent)
 
widgetparent ()
 
point get_best_size () const
 Gets the best size for the widget. More...
 
virtual bool can_mouse_focus () const
 Whether the mouse move/click event go 'through' this widget. More...
 
virtual void set_size (const point &size)
 Sets the size of the widget. More...
 
virtual void move (const int x_offset, const int y_offset)
 Moves a widget. More...
 
virtual void set_horizontal_alignment (const std::string &alignment)
 Sets the horizontal alignment of the widget within its parent grid. More...
 
virtual void set_vertical_alignment (const std::string &alignment)
 Sets the horizontal alignment of the widget within its parent grid. More...
 
point get_origin () const
 Returns the screen origin of the widget. More...
 
point get_size () const
 Returns the size of the widget. More...
 
rect get_rectangle () const
 Gets the bounding rectangle of the widget on the screen. More...
 
int get_x () const
 
int get_y () const
 
unsigned get_width () const
 
unsigned get_height () const
 
void set_linked_group (const std::string &linked_group)
 
std::string get_linked_group () const
 
SDL_Rect calculate_blitting_rectangle () const
 Calculates the blitting rectangle of the widget. More...
 
SDL_Rect calculate_clipping_rectangle () const
 Calculates the clipping rectangle of the widget. More...
 
bool draw_background ()
 Draws the background of a widget. More...
 
void draw_children ()
 Draws the children of a widget. More...
 
bool draw_foreground ()
 Draws the foreground of the widget. More...
 
SDL_Rect get_dirty_rectangle () const
 Gets the dirty rectangle of the widget. More...
 
void queue_redraw ()
 Indicates that this widget should be redrawn. More...
 
void queue_redraw (const rect &region)
 Indicate that specific region of the screen should be redrawn. More...
 
void set_visible (const visibility visible)
 
visibility get_visible () const
 
redraw_action get_drawing_action () const
 
void set_debug_border_mode (const debug_border debug_border_mode)
 
void set_debug_border_color (const color_t debug_border_color)
 
template<class T >
NOT_DANGLING T * find_widget (const std::string &id, const bool must_be_active, const bool must_exist)
 Gets a widget with the wanted id. More...
 
template<class T >
NOT_DANGLING const T * find_widget (const std::string &id, const bool must_be_active, const bool must_exist) const
 
template<class T >
NOT_DANGLING T & find_widget (const std::string &id, const bool must_be_active=false)
 Gets a widget with the wanted id. More...
 
template<class T >
NOT_DANGLING const T & find_widget (const std::string &id, const bool must_be_active=false) const
 
- Public Member Functions inherited from gui2::event_executor
 event_executor ()
 
virtual ~event_executor ()
 
void set_wants_mouse_hover (const bool hover=true)
 
bool wants_mouse_hover () const
 
void set_wants_mouse_left_double_click (const bool click=true)
 
bool wants_mouse_left_double_click () const
 
void set_wants_mouse_middle_double_click (const bool click=true)
 
bool wants_mouse_middle_double_click () const
 
event_executorset_wants_mouse_right_double_click (const bool click=true)
 
bool wants_mouse_right_double_click () const
 
- Public Member Functions inherited from gui2::event::dispatcher
 dispatcher ()
 
virtual ~dispatcher ()
 
void connect ()
 Connects the dispatcher to the event handler. More...
 
void disconnect ()
 Disconnects the dispatcher from the event handler. More...
 
bool is_connected () const
 Return whether the dispatcher is currently connected. More...
 
bool has_event (const ui_event event, const event_queue_type event_type)
 
bool fire (const ui_event event, widget &target)
 Fires an event which has no extra parameters. More...
 
bool fire (const ui_event event, widget &target, const point &coordinate)
 Fires an event which takes a coordinate parameter. More...
 
bool fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
 Fires an event which takes keyboard parameters. More...
 
bool fire (const ui_event event, widget &target, const point &pos, const point &distance)
 Fires an event which takes touch-motion parameters. More...
 
bool fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
 Fires an event which takes touch-gesture parameters. More...
 
bool fire (const ui_event event, widget &target, void *)
 Fires an event which takes notification parameters. More...
 
bool fire (const ui_event event, widget &target, const message &msg)
 Fires an event which takes message parameters. More...
 
bool fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
 Fires an event that's a raw SDL event. More...
 
bool fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
 Fires an event which takes text input parameters. More...
 
template<ui_event E, typename F >
void connect_signal (const F &func, const queue_position position=back_child)
 Adds a callback to the appropriate queue based on event type. More...
 
template<ui_event E, typename F >
void disconnect_signal (const F &func, const queue_position position=back_child)
 Removes a callback from the appropriate queue based on event type. More...
 
void capture_mouse ()
 Captures the mouse. More...
 
void release_mouse ()
 Releases the mouse capture. More...
 
void set_mouse_behavior (const mouse_behavior mouse_behavior)
 
mouse_behavior get_mouse_behavior () const
 
void set_want_keyboard_input (const bool want_keyboard_input)
 
bool get_want_keyboard_input () const
 
void register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
 Registers a hotkey. More...
 
bool execute_hotkey (const hotkey::HOTKEY_COMMAND id)
 Executes a hotkey. More...
 
- Public Member Functions inherited from enable_lua_ptr< widget >
 enable_lua_ptr (widget *tp)
 
- Public Member Functions inherited from gui2::top_level_drawable
virtual void update ()
 Update state and any parameters that may effect layout, or any of the later stages. More...
 
- Public Member Functions inherited from quit_confirmation
 quit_confirmation (const std::function< bool()> &prompt=&quit_confirmation::default_prompt)
 
 ~quit_confirmation ()
 

Protected Member Functions

void update_visible_games ()
 
void update_gamelist_diff ()
 
void update_gamelist_filter ()
 
widget_data make_game_row_data (const mp::game_info &game)
 
void adjust_game_row_contents (const mp::game_info &game, grid *grid, bool add_callbacks=true)
 
- Protected Member Functions inherited from gui2::dialogs::modal_dialog
template<typename T , typename... Args>
T * register_field (Args &&... args)
 Creates a new field of given type with given arguments. More...
 
field_boolregister_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_boolregister_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_integerregister_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_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
field_textregister_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_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
field_labelregister_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_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new styled_widget as image. More...
 
- Protected Member Functions inherited from gui2::container_base
virtual point calculate_best_size () const override
 See widget::calculate_best_size. More...
 
virtual void layout_children () override
 See widget::layout_children. More...
 
- Protected Member Functions inherited from gui2::styled_widget
resolution_definition_ptr get_config ()
 
resolution_definition_const_ptr get_config () const
 
template<typename T >
std::shared_ptr< const typename T::resolution > cast_config_to () const
 Casts the current resolution definition config to the respective type of a derived widget. More...
 
void set_config (resolution_definition_ptr config)
 
virtual void update_canvas ()
 Updates the canvas(ses). More...
 
unsigned int get_text_font_size () const
 Resolves and returns the text_font_size. More...
 
int get_text_maximum_width () const
 Returns the maximum width available for the text. More...
 
int get_text_maximum_height () const
 Returns the maximum height available for the text. More...
 
std::string get_label_token (const point &position, const char *delimiters=" \n\r\t") const
 Exposes font::pango_text::get_token, for the text label of this styled_widget. More...
 
std::string get_label_link (const point &position) const
 
- Protected Member Functions inherited from gui2::widget
void set_layout_size (const point &size)
 
const pointlayout_size () const
 
void clear_layout_size ()
 Throws away layout_size_. More...
 
- 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_drawableoperator= (const top_level_drawable &)
 
 top_level_drawable (top_level_drawable &&)
 
top_level_drawableoperator= (top_level_drawable &&)
 

Private Types

enum  JOIN_MODE { DO_JOIN , DO_OBSERVE , DO_EITHER }
 

Private Member Functions

void update_selected_game ()
 
void network_handler ()
 Network polling callback. More...
 
void process_network_data (const config &data)
 
void process_gamelist (const config &data)
 
void process_gamelist_diff (const config &data)
 
void enter_game (const mp::game_info &game, JOIN_MODE mode)
 Exits the lobby and enters the given game. More...
 
void enter_game_by_index (const int index, JOIN_MODE mode)
 Entry wrapper for enter_game, where game is located by index. More...
 
void enter_game_by_id (const int game_id, JOIN_MODE mode)
 Entry wrapper for enter_game, where game is located by game id. More...
 
void enter_selected_game (JOIN_MODE mode)
 Enter game by index, where index is the selected game listbox row. More...
 
void show_help_callback ()
 
void show_preferences_button_callback ()
 
void show_server_info ()
 
void open_profile_url ()
 
void open_match_history ()
 
void tab_switch_callback ()
 
void refresh_lobby ()
 
void game_filter_init ()
 
void game_filter_keypress_callback (const SDL_Keycode key)
 
void user_dialog_callback (const mp::user_info *info)
 
void skip_replay_changed_callback ()
 
bool exit_hook (window &window)
 
virtual const std::string & window_id () const override
 The ID of the window to build. More...
 
virtual void pre_show () override
 Actions to be taken before showing the window. More...
 
virtual void post_show () override
 Actions to be taken after the window has been shown. More...
 
- Private Member Functions inherited from gui2::dialogs::plugin_executor
 plugin_executor ()
 
 ~plugin_executor ()
 

Static Private Member Functions

static bool logout_prompt ()
 

Private Attributes

listboxgamelistbox_
 
mp::lobby_infolobby_info_
 
chatboxchatbox_
 
field_boolfilter_friends_
 
field_boolfilter_ignored_
 
field_boolfilter_slots_
 
field_boolfilter_invert_
 
bool filter_auto_hosted_
 
text_boxfilter_text_
 
int selected_game_id_
 
lobby_player_list_helper player_list_
 
bool player_list_dirty_
 
bool gamelist_dirty_
 
std::chrono::steady_clock::time_point last_lobby_update_
 
bool gamelist_diff_update_
 
wesnothd_connectionnetwork_connection_
 
std::size_t lobby_update_timer_
 Timer for updating the lobby. More...
 
std::vector< int > gamelist_id_at_row_
 
bool delay_playerlist_update_
 
bool delay_gamelist_update_
 
int & joined_game_id_
 
- Private Attributes inherited from gui2::dialogs::plugin_executor
std::unique_ptr< plugins_contextplugins_context_
 

Static Private Attributes

static std::string server_information_ = ""
 
static std::string announcements_ = ""
 

Friends

struct lobby_delay_gamelist_update_guard
 

Additional Inherited Members

- Static Public Member Functions inherited from gui2::window
static windowwindow_instance (const unsigned handle)
 Returns the instance of a window. More...
 
static retval get_retval_by_id (const std::string &id)
 Gets the retval for the default buttons. More...
 
static const std::string & type ()
 Static type getter that does not rely on the widget being constructed. More...
 
- Static Public Member Functions inherited from gui2::panel
static const std::string & type ()
 Static type getter that does not rely on the widget being constructed. More...
 
- Static Public Member Functions inherited from quit_confirmation
static bool quit ()
 Shows the quit confirmation if needed. More...
 
static void quit_to_title ()
 
static void quit_to_desktop ()
 
static bool show_prompt (const std::string &message)
 
static bool default_prompt ()
 

Detailed Description

Definition at line 37 of file lobby.hpp.

Member Enumeration Documentation

◆ JOIN_MODE

Enumerator
DO_JOIN 
DO_OBSERVE 
DO_EITHER 

Definition at line 82 of file lobby.hpp.

◆ lobby_result

Enumerator
QUIT 
JOIN 
OBSERVE 
CREATE 
RELOAD_CONFIG 

Definition at line 60 of file lobby.hpp.

Constructor & Destructor Documentation

◆ mp_lobby()

gui2::dialogs::mp_lobby::mp_lobby ( mp::lobby_info info,
wesnothd_connection connection,
int &  joined_game 
)

Definition at line 68 of file lobby.cpp.

References prefs::get().

◆ ~mp_lobby()

gui2::dialogs::mp_lobby::~mp_lobby ( )

Definition at line 134 of file lobby.cpp.

References lobby_update_timer_, and gui2::remove_timer().

Member Function Documentation

◆ adjust_game_row_contents()

void gui2::dialogs::mp_lobby::adjust_game_row_contents ( const mp::game_info game,
grid grid,
bool  add_callbacks = true 
)
protected

◆ enter_game()

void gui2::dialogs::mp_lobby::enter_game ( const mp::game_info game,
JOIN_MODE  mode 
)
private

Exits the lobby and enters the given game.

This assembles the game request for the server and handles any applicable pre-join actions, such as prompting the player for the game's password or informing them additional content needs installing.

The lobby window will be closed on completion, assuming an error wasn't encountered.

Parameters
gameInfo on the game we're attempting to join.
modeWhether joining as player, observer or whichever works.

Definition at line 801 of file lobby.cpp.

References _(), config::add_child(), DBG_LB, DO_EITHER, DO_JOIN, DO_OBSERVE, config::empty(), ERR_LB, JOIN, joined_game_id_, mp::logged_in_as_moderator(), gui2::window::mode(), OBSERVE, gui2::OK, RELOAD_CONFIG, mp::game_info::SATISFIED, mp::send_to_server(), gui2::window::set_retval(), gui2::show_error_message(), gui2::show_message(), and gui2::dialogs::message::yes_no_buttons.

Referenced by enter_game_by_id(), and enter_game_by_index().

◆ enter_game_by_id()

void gui2::dialogs::mp_lobby::enter_game_by_id ( const int  game_id,
JOIN_MODE  mode 
)
private

Entry wrapper for enter_game, where game is located by game id.

Definition at line 896 of file lobby.cpp.

References enter_game(), ERR_LB, mp::lobby_info::get_game_by_id(), lobby_info_, and gui2::window::mode().

Referenced by adjust_game_row_contents(), and pre_show().

◆ enter_game_by_index()

void gui2::dialogs::mp_lobby::enter_game_by_index ( const int  index,
JOIN_MODE  mode 
)
private

Entry wrapper for enter_game, where game is located by index.

Definition at line 885 of file lobby.cpp.

References enter_game(), ERR_LB, mp::lobby_info::games(), utf8::index(), lobby_info_, and gui2::window::mode().

Referenced by enter_selected_game().

◆ enter_selected_game()

void gui2::dialogs::mp_lobby::enter_selected_game ( JOIN_MODE  mode)
private

Enter game by index, where index is the selected game listbox row.

Definition at line 908 of file lobby.cpp.

References enter_game_by_index(), gamelistbox_, gui2::listbox::get_selected_row(), and gui2::window::mode().

Referenced by pre_show().

◆ exit_hook()

bool gui2::dialogs::mp_lobby::exit_hook ( window window)
private

Definition at line 555 of file lobby.cpp.

References gui2::CANCEL, gui2::window::get_retval(), and quit_confirmation::quit().

◆ game_filter_init()

void gui2::dialogs::mp_lobby::game_filter_init ( )
private

◆ game_filter_keypress_callback()

void gui2::dialogs::mp_lobby::game_filter_keypress_callback ( const SDL_Keycode  key)
private

Definition at line 972 of file lobby.cpp.

References update_gamelist_filter().

Referenced by pre_show().

◆ logout_prompt()

bool gui2::dialogs::mp_lobby::logout_prompt ( )
staticprivate

Definition at line 63 of file lobby.cpp.

References _().

◆ make_game_row_data()

widget_data gui2::dialogs::mp_lobby::make_game_row_data ( const mp::game_info game)
protected

◆ network_handler()

void gui2::dialogs::mp_lobby::network_handler ( )
private

◆ open_match_history()

void gui2::dialogs::mp_lobby::open_match_history ( )
private

◆ open_profile_url()

void gui2::dialogs::mp_lobby::open_profile_url ( )
private

◆ post_show()

void gui2::dialogs::mp_lobby::post_show ( )
overrideprivatevirtual

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the button with id 'ok' has been pressed).

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 697 of file lobby.cpp.

References lobby_update_timer_, gui2::dialogs::plugin_executor::plugins_context_, and gui2::remove_timer().

◆ pre_show()

void gui2::dialogs::mp_lobby::pre_show ( )
overrideprivatevirtual

Actions to be taken before showing the window.

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

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 560 of file lobby.cpp.

References gui2::chatbox::active_window_changed(), gui2::add_timer(), gui2::CANCEL, chatbox_, gui2::event::connect_signal_mouse_left_click(), gui2::event::connect_signal_notify_modified(), gui2::event::connect_signal_pre_key_press(), CREATE, default_chat_log, DO_JOIN, DO_OBSERVE, enter_game_by_id(), enter_selected_game(), filter_text_, game_filter_init(), game_filter_keypress_callback(), mp::lobby_info::gamelist(), gamelistbox_, mp::lobby_info::games(), prefs::get(), config::has_attribute(), gui2::lobby_player_list_helper::init(), gui2::window::keyboard_capture(), gui2::chatbox::load_log(), lobby_info_, game_config::lobby_network_timer, lobby_update_timer_, N_, network_handler(), gui2::window::on_all, open_match_history(), open_profile_url(), player_list_, player_list_dirty_, gui2::dialogs::plugin_executor::plugins_context_, gui2::chatbox::room_window_open(), SCOPE_LB, selected_game_id_, gui2::chatbox::send_chat_message(), gui2::chatbox::set_active_window_changed_callback(), gui2::window::set_enter_disabled(), gui2::window::set_exit_hook(), gui2::styled_widget::set_label(), gui2::window::set_retval(), gui2::menu_button::set_selected(), show_preferences_button_callback(), show_server_info(), skip_replay_changed_callback(), tab_switch_callback(), update_gamelist(), update_playerlist(), update_selected_game(), and mp::lobby_info::users().

◆ process_gamelist()

void gui2::dialogs::mp_lobby::process_gamelist ( const config data)
private

◆ process_gamelist_diff()

void gui2::dialogs::mp_lobby::process_gamelist_diff ( const config data)
private

◆ process_network_data()

void gui2::dialogs::mp_lobby::process_network_data ( const config data)
private

◆ refresh_lobby()

void gui2::dialogs::mp_lobby::refresh_lobby ( )
private

◆ show_help_callback()

void gui2::dialogs::mp_lobby::show_help_callback ( )
private

Definition at line 918 of file lobby.cpp.

References help::show_help().

◆ show_preferences_button_callback()

void gui2::dialogs::mp_lobby::show_preferences_button_callback ( )
private

Definition at line 923 of file lobby.cpp.

References refresh_lobby().

Referenced by pre_show().

◆ show_server_info()

void gui2::dialogs::mp_lobby::show_server_info ( )
private

Definition at line 930 of file lobby.cpp.

References announcements_, gui2::dialogs::server_info::display(), and server_information_.

Referenced by pre_show().

◆ skip_replay_changed_callback()

void gui2::dialogs::mp_lobby::skip_replay_changed_callback ( )
private

Definition at line 1002 of file lobby.cpp.

References prefs::get().

Referenced by pre_show().

◆ tab_switch_callback()

void gui2::dialogs::mp_lobby::tab_switch_callback ( )
private

Definition at line 683 of file lobby.cpp.

References filter_auto_hosted_, and update_gamelist_filter().

Referenced by pre_show().

◆ update_gamelist()

void gui2::dialogs::mp_lobby::update_gamelist ( )

◆ update_gamelist_diff()

void gui2::dialogs::mp_lobby::update_gamelist_diff ( )
protected

◆ update_gamelist_filter()

void gui2::dialogs::mp_lobby::update_gamelist_filter ( )
protected

◆ update_playerlist()

void gui2::dialogs::mp_lobby::update_playerlist ( )

◆ update_selected_game()

void gui2::dialogs::mp_lobby::update_selected_game ( )
private

◆ update_visible_games()

void gui2::dialogs::mp_lobby::update_visible_games ( )
protected

◆ user_dialog_callback()

void gui2::dialogs::mp_lobby::user_dialog_callback ( const mp::user_info info)
private

◆ window_id()

virtual const std::string& gui2::dialogs::mp_lobby::window_id ( ) const
overrideprivatevirtual

The ID of the window to build.

Usually set by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Friends And Related Function Documentation

◆ lobby_delay_gamelist_update_guard

friend struct lobby_delay_gamelist_update_guard
friend

Definition at line 179 of file lobby.hpp.

Member Data Documentation

◆ announcements_

std::string gui2::dialogs::mp_lobby::announcements_ = ""
inlinestaticprivate

Definition at line 182 of file lobby.hpp.

Referenced by process_network_data(), and show_server_info().

◆ chatbox_

chatbox* gui2::dialogs::mp_lobby::chatbox_
private

Definition at line 144 of file lobby.hpp.

Referenced by pre_show(), process_network_data(), and user_dialog_callback().

◆ delay_gamelist_update_

bool gui2::dialogs::mp_lobby::delay_gamelist_update_
private

◆ delay_playerlist_update_

bool gui2::dialogs::mp_lobby::delay_playerlist_update_
private

◆ filter_auto_hosted_

bool gui2::dialogs::mp_lobby::filter_auto_hosted_
private

Definition at line 150 of file lobby.hpp.

Referenced by tab_switch_callback().

◆ filter_friends_

field_bool* gui2::dialogs::mp_lobby::filter_friends_
private

Definition at line 146 of file lobby.hpp.

◆ filter_ignored_

field_bool* gui2::dialogs::mp_lobby::filter_ignored_
private

Definition at line 147 of file lobby.hpp.

◆ filter_invert_

field_bool* gui2::dialogs::mp_lobby::filter_invert_
private

Definition at line 149 of file lobby.hpp.

◆ filter_slots_

field_bool* gui2::dialogs::mp_lobby::filter_slots_
private

Definition at line 148 of file lobby.hpp.

◆ filter_text_

text_box* gui2::dialogs::mp_lobby::filter_text_
private

Definition at line 152 of file lobby.hpp.

Referenced by game_filter_init(), and pre_show().

◆ gamelist_diff_update_

bool gui2::dialogs::mp_lobby::gamelist_diff_update_
private

Definition at line 164 of file lobby.hpp.

Referenced by network_handler(), and process_gamelist().

◆ gamelist_dirty_

bool gui2::dialogs::mp_lobby::gamelist_dirty_
private

◆ gamelist_id_at_row_

std::vector<int> gui2::dialogs::mp_lobby::gamelist_id_at_row_
private

Definition at line 171 of file lobby.hpp.

Referenced by update_gamelist(), and update_gamelist_diff().

◆ gamelistbox_

listbox* gui2::dialogs::mp_lobby::gamelistbox_
private

◆ joined_game_id_

int& gui2::dialogs::mp_lobby::joined_game_id_
private

Definition at line 177 of file lobby.hpp.

Referenced by enter_game().

◆ last_lobby_update_

std::chrono::steady_clock::time_point gui2::dialogs::mp_lobby::last_lobby_update_
private

◆ lobby_info_

mp::lobby_info& gui2::dialogs::mp_lobby::lobby_info_
private

◆ lobby_update_timer_

std::size_t gui2::dialogs::mp_lobby::lobby_update_timer_
private

Timer for updating the lobby.

Definition at line 169 of file lobby.hpp.

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

◆ network_connection_

wesnothd_connection& gui2::dialogs::mp_lobby::network_connection_
private

Definition at line 166 of file lobby.hpp.

Referenced by network_handler(), and open_match_history().

◆ player_list_

lobby_player_list_helper gui2::dialogs::mp_lobby::player_list_
private

Definition at line 156 of file lobby.hpp.

Referenced by open_match_history(), open_profile_url(), pre_show(), and update_playerlist().

◆ player_list_dirty_

bool gui2::dialogs::mp_lobby::player_list_dirty_
private

◆ selected_game_id_

int gui2::dialogs::mp_lobby::selected_game_id_
private

◆ server_information_

std::string gui2::dialogs::mp_lobby::server_information_ = ""
inlinestaticprivate

Definition at line 181 of file lobby.hpp.

Referenced by process_network_data(), and show_server_info().


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