0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

MP: minor doc updates

Browse source
This commit is contained in:
Charles Dang 2021-01-13 03:00:40 +11:00
parent 6982166d4d
commit 1911906a80
1 changed files with 16 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
src/game_initialization/multiplayer.hpp
View file

@ -21,25 +21,12 @@ class config;
namespace ng { class connect_engine; }
/** Main entry points of multiplayer mode. */
namespace mp
{
// max. length of a player name
/** Max length of a player name. */
const std::size_t max_login_size = 20;
/*
* This is the main entry points of multiplayer mode.
*/
/** Starts a multiplayer game in single-user mode. */
void start_local_game();
/**
* Starts a multiplayer game in single-user mode.
*
* @param cmdline_opts The commandline options
*/
void start_local_game_commandline(const commandline_options& cmdline_opts);
/**
* Starts a multiplayer game in client mode.
*
@ -47,15 +34,29 @@ void start_local_game_commandline(const commandline_options& cmdline_opts);
*/
void start_client(const std::string& host);
/** Starts a multiplayer game in single-user mode. */
void start_local_game();
/**
* Starts a multiplayer game in single-user mode using command line settings.
*
* @param cmdline_opts The commandline options.
*/
void start_local_game_commandline(const commandline_options& cmdline_opts);
/**
* Opens the MP Staging screen and sets the game state according to the changes made.
* Meant to be used between scenarios in a campaign.
*
* @param engine A connect_engine instance to pass to MP Staging.
*/
bool goto_mp_staging(ng::connect_engine& engine);
/**
* Opens the MP Join Game screen and sets the game state according to the changes made.
* Meant to be used between scenarios in a campaign.
*
* @param observer Whether entering as an observer or player.
*/
bool goto_mp_wait(bool observe);