mp::user_info Struct Reference

This class represents the information a client has about another player. More...

#include <lobby_data.hpp>

Public Types
enum class	user_relation { ME , FRIEND , NEUTRAL , IGNORED }
enum class	user_state { LOBBY , GAME , SEL_GAME }

Public Member Functions
	user_info (const config &c)
bool	operator< (const user_info &b) const
user_state	get_state (int selected_game_id) const
user_relation	get_relation () const

Public Attributes
std::string	name
int	forum_id
int	game_id
bool	registered
bool	observing
bool	moderator

Detailed Description

This class represents the information a client has about another player.

Definition at line 29 of file lobby_data.hpp.

Member Enumeration Documentation

user_relation

enum mp::user_info::user_relation

strong

Enumerator
ME
FRIEND
NEUTRAL
IGNORED

Definition at line 33 of file lobby_data.hpp.

user_state

enum mp::user_info::user_state

strong

Enumerator
LOBBY
GAME
SEL_GAME

Definition at line 40 of file lobby_data.hpp.

Constructor & Destructor Documentation

user_info()

mp::user_info::user_info ( const config &  c )

explicit

Definition at line 52 of file lobby_data.cpp.

Member Function Documentation

get_relation()

user_info::user_relation mp::user_info::get_relation

(

)

const

Definition at line 73 of file lobby_data.cpp.

References FRIEND, IGNORED, preferences::is_friend(), preferences::is_ignored(), preferences::login(), ME, name, and NEUTRAL.

Referenced by operator<(), gui2::dialogs::lobby_player_info::pre_show(), mp::lobby_info::process_userlist(), and gui2::dialogs::lobby_player_info::update_relation().

get_state()

user_info::user_state mp::user_info::get_state

(

int

selected_game_id

)

const

Definition at line 62 of file lobby_data.cpp.

References GAME, game_id, LOBBY, and SEL_GAME.

operator<()

bool mp::user_info::operator<

(

const user_info &

b

)

const

Definition at line 86 of file lobby_data.cpp.

References b, get_relation(), translation::icompare(), and name.

Member Data Documentation

forum_id

int mp::user_info::forum_id

Definition at line 52 of file lobby_data.hpp.

game_id

int mp::user_info::game_id

Definition at line 53 of file lobby_data.hpp.

Referenced by get_state(), gui2::dialogs::lobby_player_info::pre_show(), and mp::lobby_info::process_userlist().

moderator

bool mp::user_info::moderator

Definition at line 56 of file lobby_data.hpp.

name

std::string mp::user_info::name

Definition at line 51 of file lobby_data.hpp.

Referenced by gui2::dialogs::lobby_player_info::add_to_friends_button_callback(), gui2::dialogs::lobby_player_info::add_to_ignores_button_callback(), gui2::dialogs::lobby_player_info::check_status_button_callback(), gui2::dialogs::lobby_player_info::do_kick_ban(), gui2::dialogs::lobby_player_info::do_stopgame(), get_relation(), operator<(), gui2::dialogs::lobby_player_info::pre_show(), mp::lobby_info::process_userlist(), and gui2::dialogs::lobby_player_info::remove_from_list_button_callback().

observing

bool mp::user_info::observing

Definition at line 55 of file lobby_data.hpp.

Referenced by gui2::dialogs::lobby_player_info::pre_show().

registered

bool mp::user_info::registered

Definition at line 54 of file lobby_data.hpp.

---

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

• game_initialization/lobby_data.hpp
• game_initialization/lobby_data.cpp