#include <game.hpp>

Public Member Functions
	game (wesnothd::server &server, player_connections &player_connections, player_iterator host, queue_type::type queue_type, int queue_id, const std::string &name="", bool save_replays=false, const std::string &replay_save_path="")

	~game ()

int	id () const
	This ID is reused between scenarios of MP campaigns. More...

int	db_id () const
	This ID is not reused between scenarios of MP campaigns. More...

void	next_db_id ()
	Increments the ID used when running database queries. More...

int	queue_id ()

const std::string &	name () const

bool	is_owner (player_iterator player) const

bool	is_member (player_iterator player) const

bool	allow_observers () const

bool	is_observer (player_iterator player) const

bool	is_player (player_iterator player) const

bool	player_is_banned (player_iterator player, const std::string &name) const

void	new_scenario (player_iterator sender)
	When the host sends the new scenario of a mp campaign. More...

bool	level_init () const

const std::string	get_scenario_id () const

const simple_wml::node::child_list &	get_sides_list () const

bool	started () const

std::size_t	nplayers () const

std::size_t	nobservers () const

std::size_t	current_turn () const

std::string	get_replay_filename ()

void	mute_all_observers ()
	Toggles whether all observers are muted or not. More...

void	mute_observer (const simple_wml::node &mute, player_iterator muter)
	Mute an observer or give a message of all currently muted observers if no name is given. More...

void	unmute_observer (const simple_wml::node &unmute, player_iterator unmuter)
	Unmute an observer or unmute all currently muted observers if no name is given. More...

utils::optional< player_iterator >	kick_member (const simple_wml::node &kick, player_iterator kicker)
	Kick a user from this game by name. More...

utils::optional< player_iterator >	ban_user (const simple_wml::node &ban, player_iterator banner)
	Ban a user by name. More...

void	unban_user (const simple_wml::node &unban, player_iterator unbanner)
	Unban a user by name. More...

bool	add_player (player_iterator player, bool observer=false)
	Add a user to the game. More...

bool	remove_player (player_iterator player, const bool disconnect=false, const bool destruct=false)
	Removes a user from the game. More...

const user_vector	all_game_users () const

void	start_game (player_iterator starter)
	Starts the game (if a new game) or starts the next scenario of an MP campaign. More...

void	perform_controller_tweaks ()
	This is performed just before starting and before the [start_game] signal. More...

void	load_next_scenario (player_iterator user)
	A user asks for the next scenario to advance to. More...

void	update_side_data ()
	Resets the side configuration according to the scenario data. More...

void	transfer_side_control (player_iterator player, const simple_wml::node &cfg)
	Lets a player owning a side give it to another player or observer. More...

void	process_message (simple_wml::document &data, player_iterator user)
	Sends an ingame message to all other players. More...

bool	process_turn (simple_wml::document &data, player_iterator user)
	Handles [end_turn], repackages [commands] with private [speak]s in them and sends the data. More...

void	process_whiteboard (simple_wml::document &data, player_iterator user)
	Handles incoming [whiteboard] data. More...

void	process_change_turns_wml (simple_wml::document &data, player_iterator user)
	Handles incoming [change_turns_wml] data. More...

void	describe_slots ()
	Set the description to the number of available slots. More...

void	send_server_message_to_all (const char *message, utils::optional< player_iterator > exclude={})
	Sends a message to all players in this game that aren't excluded. More...

void	send_server_message_to_all (const std::string &message, utils::optional< player_iterator > exclude={})
	send_server_message_to_all More...

void	send_server_message (const char message, utils::optional< player_iterator > player={}, simple_wml::document doc=nullptr) const
	Send a server message to the specified player. More...

void	send_server_message (const std::string &message, utils::optional< player_iterator > player={}, simple_wml::document *doc=nullptr) const
	send_server_message More...

void	send_and_record_server_message (const char *message, utils::optional< player_iterator > exclude={})
	Send data to all players in this game except 'exclude'. More...

void	send_and_record_server_message (const std::string &message, utils::optional< player_iterator > exclude={})
	send_and_record_server_message More...

template<typename Container >
void	send_to_players (simple_wml::document &data, const Container &players, utils::optional< player_iterator > exclude={})
	Send data to all players except those excluded. More...

void	send_data (simple_wml::document &data, utils::optional< player_iterator > exclude={})
	Send data to all players and observers except those excluded. More...

void	clear_history ()
	Clears the history of recorded WML documents. More...

void	clear_chat_history ()
	Clears the history of recorded chat WML documents. More...

void	record_data (std::unique_ptr< simple_wml::document > data)
	Records a WML document in the game's history. More...

void	save_replay ()
	Move the level information and recorded history into a replay file and save it. More...

simple_wml::document &	level ()

void	set_description (simple_wml::node *desc)
	Set the game's description. More...

simple_wml::node *	description () const

simple_wml::node *	description_for_writing ()

simple_wml::node *	changed_description ()

void	set_password (const std::string &passwd)
	Sets the password required to access the game. More...

void	set_name_bans (const std::vector< std::string > name_bans)
	Set a list of usernames that should all be banned from joining the game. More...

bool	password_matches (const std::string &passwd) const

bool	has_password () const

const std::string &	termination_reason () const
	Provides the reason the game was ended. More...

void	set_termination_reason (const std::string &reason)
	Sets the termination reason for this game. More...

void	handle_choice (const simple_wml::node &data, player_iterator user)
	Handle a choice requested by a client, such as changing a side's controller, if initiated by WML/lua. More...

void	handle_random_choice ()
	Send a randomly generated number to the requestor. More...

void	handle_controller_choice (const simple_wml::node &data)
	Handle a request to change a side's controller. More...

void	handle_add_side_wml ()
	Adds a new, empty side owned by no one. More...

void	reset_last_synced_context_id ()
	Reset the internal counter for choice requests made by clients to the server. More...

bool	controls_side (const std::vector< int > &sides, player_iterator player) const
	Function which returns true if 'player' controls any of the sides specified in 'sides'. More...

bool	is_reload () const

void	emergency_cleanup ()

queue_type::type	q_type () const

bool	is_open_queue_game (int q_id)

int	get_vacant_slots ()

Static Public Member Functions
static simple_wml::node *	starting_pos (simple_wml::node &data)
	The non-const version. More...

static const simple_wml::node *	starting_pos (const simple_wml::node &data)
	The const version. More...

Private Member Functions
	game (const game &)=delete

game &	operator= (const game &)=delete

std::size_t	current_side () const

utils::optional< player_iterator >	get_side_player (std::size_t index) const

utils::optional< player_iterator >	current_player () const

bool	is_current_player (player_iterator player) const

bool	is_muted_observer (player_iterator player) const

bool	all_observers_muted () const

void	send_muted_observers (player_iterator user) const
	Sends a message either stating that all observers are muted or listing the observers that are muted. More...

bool	send_taken_side (simple_wml::document &cfg, const simple_wml::node *side) const
	Tell the host who owns a side. More...

bool	take_side (player_iterator user)
	Figures out which side to take and tells that side to the game owner. More...

void	change_controller (const std::size_t side_index, player_iterator player, const std::string &player_name, const bool player_left=true)
	Send [change_controller] message to tell all clients the new controller's name or controller type (human or ai). More...

std::unique_ptr< simple_wml::document >	change_controller_type (const std::size_t side_index, player_iterator player, const std::string &player_name)
	Tell everyone else but the source player that the controller type changed. More...

void	send_leave_game (player_iterator user) const
	Tells a player to leave the game. More...

void	send_data_sides (simple_wml::document &data, const simple_wml::string_span &sides, utils::optional< player_iterator > exclude={})
	Sends a document to the provided list of sides. More...

void	send_observerjoins (utils::optional< player_iterator > player={})
	Send a document per observer in the game. More...

void	send_observerquit (player_iterator observer)

void	send_history (player_iterator sock) const

void	send_chat_history (player_iterator sock) const

void	notify_new_host ()
	In case of a host transfer, notify the new host about its status. More...

utils::optional< player_iterator >	find_user (const simple_wml::string_span &name)
	Shortcut to a convenience function for finding a user by name. More...

bool	is_legal_command (const simple_wml::node &command, player_iterator user)

std::string	has_same_ip (player_iterator user) const
	Checks whether a user has the same IP as any other members of this game. More...

void	end_turn (int new_side)
	Function which should be called every time a player ends their turn (i.e. More...

void	init_turn ()
	Function which should be called every time a player starts their turn (i.e. More...

void	update_turn_data ()
	Set or update the current and max turn values in the game's description. More...

void	send_user_list (utils::optional< player_iterator > exclude={})
	Function to send a list of users to all clients. More...

std::string	username (player_iterator pl) const

std::string	list_users (const user_vector &users) const

void	reset_sides ()
	calculates the initial value for sides_, side_controllerds_, nsides_ More...

std::string	debug_player_info () const
	Helps debugging player and observer lists. More...

std::string	debug_sides_info () const
	Helps debugging controller tweaks. More...

int	get_next_side_index () const

int	get_next_nonempty (int side_index) const
	finds the first side starting at side_index that is non empty. More...

Private Attributes
wesnothd::server &	server
	The wesnothd server instance this game exists on. More...

player_connections &	player_connections_

int	id_
	This game's ID within wesnothd. More...

int	db_id_
	Used for unique identification of games played in the database. More...

std::string	name_
	The name of the game. More...

std::string	password_
	The password needed to join the game. More...

player_iterator	owner_
	The game host or later owner (if the host left). More...

user_vector	players_
	A vector of players (members owning a side). More...

user_vector	observers_
	A vector of observers (members not owning a side). More...

user_vector	muted_observers_
	A vector of muted observers. More...

side_vector	sides_
	A vector of side owners. More...

std::vector< side_controller::type >	side_controllers_
	A vector containiner the controller type for each side. More...

int	nsides_
	Number of sides in the current scenario. More...

bool	started_
	Whether the game has been started or not. More...

simple_wml::document	level_
	The current scenario data. More...

std::vector< std::unique_ptr< simple_wml::document > >	history_
	Replay data. More...

std::vector< std::unique_ptr< simple_wml::document > >	chat_history_
	Replay chat history data. More...

simple_wml::node *	description_
	Pointer to the game's description in the games_and_users_list_. More...

bool	description_updated_
	Set to true whenever description_ was changed that an update needs to be sent to clients. More...

int	current_turn_
	The game's current turn. More...

int	current_side_index_
	The index of the current side. More...

int	next_side_index_
	after [end_turn] was received, this contains the side for who we accept [init_side]. More...

int	num_turns_
	The maximum number of turns before the game ends. More...

bool	all_observers_muted_
	Whether all observers should be treated as muted. More...

std::vector< std::string >	bans_
	List of banned IPs. More...

std::vector< std::string >	name_bans_
	List of banned usernames. More...

std::set< const player_record * >	players_not_advanced_
	in multiplayer campaigns it can happen that some players are still in the previous scenario keep track of those players because processing certain input from those side wil lead to error (oos) More...

std::string	termination_
	The reason the game ended. More...

bool	save_replays_
	Whether to save a replay of this game. More...

std::string	replay_save_path_
	Where to save the replay of this game. More...

randomness::mt_rng	rng_
	A wrapper for mersenne twister rng which generates randomness for this game. More...

int	last_choice_request_id_
	The ID of the last request received from a client. More...

queue_type::type	queue_type_
	Whether this game was created manually or by joining a queue. More...

int	queue_id_
	Which server-side queue this game came from. More...

Static Private Attributes
static int	id_num = 1
	Incremented to retrieve a unique ID for game instances within wesnothd. More...

static int	db_id_num = 1
	Incremented to retrieve a unique ID per wesnothd instance for game instances within the database. More...

Detailed Description

Definition at line 36 of file game.hpp.

Constructor & Destructor Documentation

◆ game() [1/2]

wesnothd::game::game	(	wesnothd::server &	server,
		player_connections &	player_connections,
		player_iterator	host,
		queue_type::type	queue_type,
		int	queue_id,
		const std::string &	name = `""`,
		bool	save_replays = `false`,
		const std::string &	replay_save_path = `""`
	)

Definition at line 78 of file game.cpp.

References id_, name_, owner_, players_, and wesnothd::player::PLAYING.

◆ ~game()

wesnothd::game::~game ( )

Definition at line 127 of file game.cpp.

References all_game_users(), clear_history(), ERR_GAME, utils::get_unknown_exception_type(), remove_player(), and save_replay().

◆ game() [2/2]

wesnothd::game::game ( const game & )

privatedelete

Member Function Documentation

◆ add_player()

bool wesnothd::game::add_player	(	player_iterator	player,
		bool	observer = `false`
	)

Add a user to the game.

Todo:: differentiate between "observers not allowed" and "player already in the game" errors. maybe return a string with an error message.

Parameters

player	The player to add.
observer	Whether to add the player as an observer.

Returns: True if the user successfully joined the game, false otherwise.

Definition at line 1364 of file game.cpp.

References simple_wml::node::add_child(), allow_observers(), db_id_, DBG_GAME, debug_player_info(), ERR_GAME, has_same_ip(), id_, simple_wml::INIT_COMPRESSED, is_member(), level_, LOG_GAME, wesnothd::player::name(), name_, game_config::images::observer, observers_, wesnothd::player::OBSERVING, players_, wesnothd::player::PLAYING, simple_wml::document::root(), send_and_record_server_message(), send_chat_history(), send_data(), send_history(), send_observerjoins(), send_server_message(), wesnothd::server::send_to_player(), send_user_list(), simple_wml::node::set_attr_dup(), started_, and take_side().

◆ all_game_users()

const user_vector wesnothd::game::all_game_users ( ) const

Returns: A vector containing all players and observers currently in this game.

Definition at line 1899 of file game.cpp.

References observers_, and players_.

Referenced by has_same_ip(), new_scenario(), send_data(), send_user_list(), update_side_data(), and ~game().

◆ all_observers_muted()

bool wesnothd::game::all_observers_muted ( ) const

inlineprivate

Returns: True if all observers have been muted via that command (not if each individual observer happens to have been manually muted).

Definition at line 692 of file game.hpp.

References all_observers_muted_.

◆ allow_observers()

bool wesnothd::game::allow_observers ( ) const

Returns: Whether observers are allowed to join.

Definition at line 160 of file game.cpp.

References wesnothd::get_multiplayer(), level_, and simple_wml::document::root().

Referenced by add_player().

◆ ban_user()

utils::optional< player_iterator > wesnothd::game::ban_user	(	const simple_wml::node &	ban,
		player_iterator	banner
	)

Ban a user by name.

The user does not need to be in this game but logged in.

Parameters

ban	The user to ban.
banner	The player doing the banning.

Returns: The iterator to the banned player if he was in this game, empty optional otherwise.

Definition at line 823 of file game.cpp.

References bans_, db_id_, find_user(), id_, is_member(), LOG_GAME, name_, name_bans_, owner_, player_is_banned(), remove_player(), send_and_record_server_message(), send_leave_game(), send_server_message(), and username().

◆ change_controller()

void wesnothd::game::change_controller	(	const std::size_t	side_index,
		player_iterator	player,
		const std::string &	player_name,
		const bool	player_left = `true`
	)

private

Send [change_controller] message to tell all clients the new controller's name or controller type (human or ai).

Parameters

side_index	The index of the side whose controller is changing.
player	The player who is taking control of the side.
player_name	The name of the player who is taking control of the side.
player_left	We use the "player_left" field as follows. Normally change_controller sends one message to the owner, and one message to everyone else. In case that a player drops, the owner is gone and should not get a message, instead the host gets a [side_drop] message.

Definition at line 597 of file game.cpp.

References change_controller_type(), DBG_GAME, record_data(), send_and_record_server_message(), wesnothd::server::send_to_player(), side_controllers_, sides_, and started_.

Referenced by perform_controller_tweaks(), remove_player(), and transfer_side_control().

◆ change_controller_type()

std::unique_ptr< simple_wml::document > wesnothd::game::change_controller_type	(	const std::size_t	side_index,
		player_iterator	player,
		const std::string &	player_name
	)

private

Tell everyone else but the source player that the controller type changed.

Parameters

side_index	The index of the side whose controller type is changing.
player	The player who owns the side whose controller type is changing.
player_name	The name of the player who owns the side whose controller type is changing.

Returns: The document that was sent to all other players.

Definition at line 629 of file game.cpp.

References simple_wml::node::add_child(), simple_wml::document::clone(), string_enums::enum_base< Definition >::get_string(), simple_wml::document::root(), send_data(), simple_wml::node::set_attr(), simple_wml::node::set_attr_dup(), and side_controllers_.

Referenced by change_controller(), and transfer_side_control().

◆ changed_description()

simple_wml::node* wesnothd::game::changed_description ( )

inline

Returns: The node containing the game's current description if it was changed.

Definition at line 505 of file game.hpp.

References description_, and description_updated_.

◆ clear_chat_history()

void wesnothd::game::clear_chat_history ( )

Clears the history of recorded chat WML documents.

Definition at line 1872 of file game.cpp.

References chat_history_.

Referenced by start_game().

◆ clear_history()

void wesnothd::game::clear_history ( )

Clears the history of recorded WML documents.

Definition at line 1867 of file game.cpp.

References history_.

Referenced by start_game(), and ~game().

◆ controls_side()

bool wesnothd::game::controls_side	(	const std::vector< int > &	sides,
		player_iterator	player
	)		const

Function which returns true if 'player' controls any of the sides specified in 'sides'.

Parameters

sides	The list of sides in this game.
player	The player being checked for whether they own any sides.

Definition at line 1677 of file game.cpp.

References sides_.

◆ current_player()

utils::optional<player_iterator> wesnothd::game::current_player ( ) const

inlineprivate

Returns: The player who owns the current side.

Definition at line 668 of file game.hpp.

References current_side(), and get_side_player().

Referenced by handle_controller_choice(), is_current_player(), and process_turn().

◆ current_side()

std::size_t wesnothd::game::current_side ( ) const

inlineprivate

Returns: 0 if there are no sides, or the current side index otherwise.

Definition at line 648 of file game.hpp.

References current_side_index_, and get_next_nonempty().

Referenced by current_player(), and process_turn().

◆ current_turn()

std::size_t wesnothd::game::current_turn ( ) const

inline

Returns: This game's current turn.

Definition at line 221 of file game.hpp.

References current_turn_.

Referenced by get_replay_filename(), process_change_turns_wml(), remove_player(), and update_turn_data().

◆ db_id()

int wesnothd::game::db_id ( ) const

inline

This ID is not reused between scenarios of MP campaigns.

This ID resets when wesnothd is restarted. This is generally used during database queries.

Returns: an ID that uniquely identifies the game within the currently running wesnothd instance.

Definition at line 67 of file game.hpp.

References db_id_.

Referenced by wesnothd::server::cleanup_game().

◆ debug_player_info()

std::string wesnothd::game::debug_player_info ( ) const

private

Helps debugging player and observer lists.

Returns: A string listing the game IDs, players, and observers.

Definition at line 1909 of file game.cpp.

References db_id_, id_, observers_, and players_.

Referenced by add_player(), remove_player(), and update_side_data().

◆ debug_sides_info()

std::string wesnothd::game::debug_sides_info ( ) const

private

Helps debugging controller tweaks.

Returns: A string listing the game IDs and side information.

Definition at line 1925 of file game.cpp.

References db_id_, get_sides_list(), string_enums::enum_base< Definition >::get_string(), id_, s, and side_controllers_.

Referenced by load_next_scenario(), perform_controller_tweaks(), and start_game().

◆ describe_slots()

void wesnothd::game::describe_slots ( )

Set the description to the number of available slots.

Definition at line 656 of file game.cpp.

References simple_wml::node::child_or_add(), description_, description_for_writing(), get_sides_list(), i, simple_wml::node::set_attr_int(), sides_, and started_.

◆ description()

simple_wml::node* wesnothd::game::description ( ) const

inline

Returns: The node containing the game's current description.

Definition at line 488 of file game.hpp.

References description_.

Referenced by wesnothd::server::cleanup_game().

◆ description_for_writing()

simple_wml::node* wesnothd::game::description_for_writing ( )

inline

Returns: The node containing the game's current description. and remembers that it was changed.

Definition at line 496 of file game.hpp.

References description_, and description_updated_.

Referenced by describe_slots(), process_change_turns_wml(), and update_turn_data().

◆ emergency_cleanup()

void wesnothd::game::emergency_cleanup ( )

inline

Definition at line 618 of file game.hpp.

References observers_, and players_.

Referenced by wesnothd::server::cleanup_game().

◆ end_turn()

void wesnothd::game::end_turn ( int new_side )

private

Function which should be called every time a player ends their turn (i.e.

[end_turn] received).

Parameters

new_side The side number whose turn to move it has become.

Definition at line 1329 of file game.cpp.

References current_side_index_, and next_side_index_.

Referenced by process_turn().

◆ find_user()

utils::optional< player_iterator > wesnothd::game::find_user ( const simple_wml::string_span & name )

private

Shortcut to a convenience function for finding a user by name.

Parameters

name	The name of the user to find.

Returns: The player if found, else empty.

Definition at line 1944 of file game.cpp.

References utils::find(), name(), and player_connections_.

Referenced by ban_user(), kick_member(), mute_observer(), transfer_side_control(), unban_user(), and unmute_observer().

◆ get_next_nonempty()

int wesnothd::game::get_next_nonempty ( int side_index ) const

private

finds the first side starting at side_index that is non empty.

Definition at line 2015 of file game.cpp.

References i, modulo(), nsides_, and side_controllers_.

Referenced by current_side(), and get_next_side_index().

◆ get_next_side_index()

int wesnothd::game::get_next_side_index ( ) const

private

Returns: the side index for which we accept [init_side]

Definition at line 2010 of file game.cpp.

References get_next_nonempty(), and next_side_index_.

Referenced by init_turn(), and is_legal_command().

◆ get_replay_filename()

std::string wesnothd::game::get_replay_filename ( )

Returns: The name of the replay for this game.

Definition at line 1795 of file game.cpp.

References current_turn(), db_id_, utils::erase_if(), filename, wesnothd::is_invalid_filename_char(), level_, name(), simple_wml::document::root(), and starting_pos().

Referenced by wesnothd::server::cleanup_game(), and save_replay().

◆ get_scenario_id()

const std::string wesnothd::game::get_scenario_id ( ) const

Definition at line 155 of file game.cpp.

References wesnothd::get_multiplayer(), level_, and simple_wml::document::root().

◆ get_side_player()

utils::optional<player_iterator> wesnothd::game::get_side_player ( std::size_t index ) const

inlineprivate

Returns: The player who owns the side at index index. nullopt if wither index is invalid or the side is not owned.

Definition at line 660 of file game.hpp.

References utf8::index(), and sides_.

Referenced by current_player(), and is_legal_command().

◆ get_sides_list()

const simple_wml::node::child_list& wesnothd::game::get_sides_list ( ) const

inline

Returns: The nodes containing the sides in this game.

Definition at line 189 of file game.hpp.

References simple_wml::node::children(), level_, simple_wml::document::root(), and starting_pos().

Referenced by debug_sides_info(), describe_slots(), perform_controller_tweaks(), reset_sides(), start_game(), take_side(), transfer_side_control(), and update_side_data().

◆ get_vacant_slots()

int wesnothd::game::get_vacant_slots ( )

inline

Definition at line 636 of file game.hpp.

References simple_wml::node::attr(), simple_wml::node::child(), description_, and simple_wml::string_span::to_int().

Referenced by is_open_queue_game().

◆ handle_add_side_wml()

void wesnothd::game::handle_add_side_wml ( )

Adds a new, empty side owned by no one.

Definition at line 1160 of file game.cpp.

References nsides_, side_controllers_, and sides_.

Referenced by handle_choice().

◆ handle_choice()

void wesnothd::game::handle_choice	(	const simple_wml::node &	data,
		player_iterator	user
	)

Handle a choice requested by a client, such as changing a side's controller, if initiated by WML/lua.

Parameters

data	The data needed to process the choice.
user	The player making the request.

Definition at line 1232 of file game.cpp.

References data, DBG_GAME, handle_add_side_wml(), handle_controller_choice(), handle_random_choice(), is_player(), last_choice_request_id_, owner_, players_not_advanced_, send_and_record_server_message(), and started_.

◆ handle_controller_choice()

void wesnothd::game::handle_controller_choice ( const simple_wml::node & data )

Handle a request to change a side's controller.

Note that this does not change who owns a side.

Parameters

data	Contains the information about which side to change the controller of.

Definition at line 1167 of file game.cpp.

References simple_wml::node::add_child(), current_player(), string_enums::enum_base< Definition >::get_enum(), string_enums::enum_base< Definition >::get_string(), last_choice_request_id_, record_data(), send_and_record_server_message(), send_data(), wesnothd::server::send_to_player(), simple_wml::node::set_attr(), simple_wml::node::set_attr_dup(), simple_wml::node::set_attr_int(), side_controllers_, and sides_.

Referenced by handle_choice().

◆ handle_random_choice()

void wesnothd::game::handle_random_choice ( )

Send a randomly generated number to the requestor.

Definition at line 1138 of file game.cpp.

References simple_wml::node::add_child(), randomness::mt_rng::get_next_random(), last_choice_request_id_, record_data(), rng_, send_data(), simple_wml::node::set_attr(), simple_wml::node::set_attr_dup(), and simple_wml::node::set_attr_int().

Referenced by handle_choice().

◆ has_password()

bool wesnothd::game::has_password ( ) const

inline

Returns: Whether the game has a password set.

Definition at line 546 of file game.hpp.

References password_.

◆ has_same_ip()

std::string wesnothd::game::has_same_ip ( player_iterator user ) const

private

Checks whether a user has the same IP as any other members of this game.

Returns: A comma separated string of members with matching IPs.

Definition at line 1690 of file game.cpp.

References all_game_users().

Referenced by add_player().

◆ id()

int wesnothd::game::id ( ) const

inline

This ID is reused between scenarios of MP campaigns.

This ID resets when wesnothd is restarted. This is generally used when needing to find a particular running game.

Returns: an ID that uniquely identifies the game within the currently running wesnothd instance.

Definition at line 55 of file game.hpp.

References id_.

Referenced by wesnothd::server::cleanup_game().

◆ init_turn()

void wesnothd::game::init_turn ( )

private

Function which should be called every time a player starts their turn (i.e.

[init_side] received). This will update the 'turn' attribute for the game's description when appropriate.

Definition at line 1338 of file game.cpp.

References current_side_index_, current_turn_, get_next_side_index(), next_side_index_, and update_turn_data().

Referenced by process_turn().

◆ is_current_player()

bool wesnothd::game::is_current_player ( player_iterator player ) const

inlineprivate

Parameters

player The player being checked.

Returns: Whether the player being checked is the current player taking their turn.

Definition at line 678 of file game.hpp.

References current_player().

Referenced by is_legal_command(), and process_turn().

◆ is_legal_command()

bool wesnothd::game::is_legal_command	(	const simple_wml::node &	command,
		player_iterator	user
	)

private

Definition at line 907 of file game.cpp.

References simple_wml::node::attr(), simple_wml::node::child(), get_next_side_index(), get_side_player(), simple_wml::node::has_attr(), is_current_player(), simple_wml::string_span::is_null(), is_player(), simple_wml::node::one_child(), owner_, and simple_wml::string_span::to_int().

Referenced by process_turn().

◆ is_member()

bool wesnothd::game::is_member ( player_iterator player ) const

inline

Parameters

player The player being checked.

Returns: Whether the provided player has joined the game.

Definition at line 106 of file game.hpp.

References is_observer(), and is_player().

Referenced by add_player(), ban_user(), kick_member(), remove_player(), and transfer_side_control().

◆ is_muted_observer()

bool wesnothd::game::is_muted_observer ( player_iterator player ) const

private

Parameters

player The observer being checked.

Returns: True if the observer is muted or if all observers are muted, false otherwise.

Definition at line 170 of file game.cpp.

References all_observers_muted_, utils::find(), is_observer(), and muted_observers_.

Referenced by mute_observer(), process_turn(), and unmute_observer().

◆ is_observer()

bool wesnothd::game::is_observer ( player_iterator player ) const

Parameters

player The player being checked.

Returns: Whether the provided player is an observer of this game.

Definition at line 165 of file game.cpp.

References utils::find(), and observers_.

Referenced by is_member(), is_muted_observer(), mute_observer(), remove_player(), send_user_list(), transfer_side_control(), and unmute_observer().

◆ is_open_queue_game()

bool wesnothd::game::is_open_queue_game ( int q_id )

inline

Definition at line 629 of file game.hpp.

References get_vacant_slots(), queue_id_, queue_type_, and started_.

◆ is_owner()

bool wesnothd::game::is_owner ( player_iterator player ) const

inline

Parameters

player The player being checked.

Returns: Whether the provided player is the game's owner(host).

Definition at line 97 of file game.hpp.

References owner_.

Referenced by send_user_list().

◆ is_player()

bool wesnothd::game::is_player ( player_iterator player ) const

Parameters

player The player being checked.

Returns: Whether the provided player is playing this game (aka owns one or more sides).

Definition at line 183 of file game.cpp.

References utils::find(), and players_.

Referenced by handle_choice(), is_legal_command(), is_member(), process_change_turns_wml(), process_turn(), process_whiteboard(), remove_player(), and transfer_side_control().

◆ is_reload()

bool wesnothd::game::is_reload ( ) const

Returns: Whether the loaded WML has the attribute indicating that this is a reloaded savegame rather than a brand new game.

Definition at line 2004 of file game.cpp.

References wesnothd::get_multiplayer(), simple_wml::node::has_attr(), level_, and simple_wml::document::root().

◆ kick_member()

utils::optional< player_iterator > wesnothd::game::kick_member	(	const simple_wml::node &	kick,
		player_iterator	kicker
	)

Kick a user from this game by name.

Parameters

kick	The user to kick.
kicker	The player doing the kicking.

Returns: The iterator to the removed member if successful, empty optional otherwise.

Definition at line 791 of file game.cpp.

References db_id_, find_user(), id_, is_member(), LOG_GAME, name_, owner_, remove_player(), send_and_record_server_message(), send_leave_game(), send_server_message(), and username().

◆ level()

simple_wml::document& wesnothd::game::level ( )

inline

Returns: The full scenario data.

Definition at line 472 of file game.hpp.

References level_.

◆ level_init()

bool wesnothd::game::level_init ( ) const

inline

Returns: Whether this game contains scenario data and thus has been initialized.

Definition at line 145 of file game.hpp.

References simple_wml::document::child(), and level_.

◆ list_users()

std::string wesnothd::game::list_users ( const user_vector & users ) const

private

Parameters

users The users to create a comma separated list from.

Returns: A comma separated list of user names.

Definition at line 193 of file game.cpp.

Referenced by send_muted_observers(), and start_game().

◆ load_next_scenario()

void wesnothd::game::load_next_scenario ( player_iterator user )

A user asks for the next scenario to advance to.

Parameters

user	The user asking for the next scenario.

Definition at line 1594 of file game.cpp.

References simple_wml::node::add_child(), simple_wml::node::copy_into(), DBG_GAME, debug_sides_info(), level_, players_not_advanced_, simple_wml::document::root(), send_history(), send_observerjoins(), send_server_message_to_all(), wesnothd::server::send_to_player(), simple_wml::node::set_attr(), sides_, and started_.

◆ mute_all_observers()

void wesnothd::game::mute_all_observers ( )

Toggles whether all observers are muted or not.

Definition at line 690 of file game.cpp.

References all_observers_muted_, and send_and_record_server_message().

◆ mute_observer()

void wesnothd::game::mute_observer	(	const simple_wml::node &	mute,
		player_iterator	muter
	)

Mute an observer or give a message of all currently muted observers if no name is given.

Parameters

mute	The observer to mute. Empty if sending a message to muted observers.
muter	The player doing the muting.

Definition at line 712 of file game.cpp.

References db_id_, find_user(), id_, is_muted_observer(), is_observer(), LOG_GAME, muted_observers_, name_, owner_, send_and_record_server_message(), send_muted_observers(), send_server_message(), and username().

◆ name()

const std::string& wesnothd::game::name ( ) const

inline

Returns: The game's name.

Definition at line 88 of file game.hpp.

References name_.

Referenced by find_user(), get_replay_filename(), and player_is_banned().

◆ new_scenario()

void wesnothd::game::new_scenario ( player_iterator sender )

When the host sends the new scenario of a mp campaign.

Parameters

sender The player sending the scenario data.

Definition at line 1582 of file game.cpp.

References all_game_users(), owner_, players_not_advanced_, and started_.

◆ next_db_id()

void wesnothd::game::next_db_id ( )

inline

Increments the ID used when running database queries.

Definition at line 75 of file game.hpp.

References db_id_, and db_id_num.

◆ nobservers()

std::size_t wesnothd::game::nobservers ( ) const

inline

Returns: The number of observers in this game.

Definition at line 213 of file game.hpp.

References observers_.

◆ notify_new_host()

void wesnothd::game::notify_new_host ( )

private

In case of a host transfer, notify the new host about its status.

Definition at line 645 of file game.cpp.

References config::add_child(), cfg, owner_, send_and_record_server_message(), wesnothd::server::send_to_player(), and username().

Referenced by remove_player().

◆ nplayers()

std::size_t wesnothd::game::nplayers ( ) const

inline

Returns: The number of players. One player can have multiple sides.

Definition at line 205 of file game.hpp.

References players_.

◆ operator=()

game& wesnothd::game::operator= ( const game & )

privatedelete

◆ password_matches()

bool wesnothd::game::password_matches ( const std::string & passwd ) const

inline

Parameters

passwd The password to join with.

Returns: True if the game's password is empty or if the provided password matches, false otherwise.

Definition at line 538 of file game.hpp.

References password_.

◆ perform_controller_tweaks()

void wesnothd::game::perform_controller_tweaks ( )

This is performed just before starting and before the [start_game] signal.

Sends [scenario_diff]s specific to each client so that they locally control their human sides.

Definition at line 208 of file game.cpp.

References change_controller(), db_id_, DBG_GAME, debug_sides_info(), get_sides_list(), id_, LOG_GAME, wfl::msg(), owner_, send_and_record_server_message(), simple_wml::node::set_attr(), sides_, update_side_data(), and username().

◆ player_is_banned()

bool wesnothd::game::player_is_banned	(	player_iterator	player,
		const std::string &	name
	)		const

Parameters

player	The player being checked (by iterator).
name	The player being checked (by username).

Returns: Whether the connection's ip address or username is banned from this game.

Definition at line 682 of file game.cpp.

References bans_, utils::find(), name(), and name_bans_.

Referenced by ban_user(), and unban_user().

◆ process_change_turns_wml()

void wesnothd::game::process_change_turns_wml	(	simple_wml::document &	data,
		player_iterator	user
	)

Handles incoming [change_turns_wml] data.

Parameters

data	The [change_turns_wml] data.
user	The player changing turns.

Definition at line 1303 of file game.cpp.

References simple_wml::node::child_or_add(), simple_wml::node::copy_into(), current_turn(), current_turn_, data, description_for_writing(), is_player(), num_turns_, and started_.

◆ process_message()

void wesnothd::game::process_message	(	simple_wml::document &	data,
		player_iterator	user
	)

Sends an ingame message to all other players.

Parameters

data	The message to send.
user	The user sending the message.

Definition at line 895 of file game.cpp.

References chat_history_, data, wfl::msg(), send_data(), and wesnothd::chat_message::truncate_message().

◆ process_turn()

bool wesnothd::game::process_turn	(	simple_wml::document &	data,
		player_iterator	user
	)

Handles [end_turn], repackages [commands] with private [speak]s in them and sends the data.

Also filters commands from all but the current player. Currently removes all commands but [speak] for observers and all but [speak], [label], and [rename] for players.

Parameters

data	The turn commands.
user	The user who sent a command to be processed during the turn. This may not be the player whose turn it currently is.

Returns: True if the turn ended.

Definition at line 977 of file game.cpp.

References simple_wml::node::add_child(), cfg, simple_wml::node::child(), simple_wml::node::children(), simple_wml::node::copy_into(), current_player(), current_side(), current_side_index_, current_turn_, data, db_id_, DBG_GAME, simple_wml::string_span::empty(), end_turn(), ERR_GAME, utils::find(), id_, utf8::index(), init_turn(), is_current_player(), is_legal_command(), is_muted_observer(), is_player(), LOG_GAME, wfl::msg(), simple_wml::node::no_children(), simple_wml::node_to_string(), nsides_, game_config::observer_team_name, observers_, owner_, record_data(), simple_wml::node::remove_child(), s, send_and_record_server_message(), send_data(), send_data_sides(), send_server_message(), send_to_players(), simple_wml::node::set_attr(), simple_wml::node::set_attr_dup(), sides_, started_, transfer_side_control(), wesnothd::chat_message::truncate_message(), and username().

◆ process_whiteboard()

void wesnothd::game::process_whiteboard	(	simple_wml::document &	data,
		player_iterator	user
	)

Handles incoming [whiteboard] data.

Parameters

data	The whiteboard data.
user	The user sending the whiteboard data.

Definition at line 1276 of file game.cpp.

References data, is_player(), LOG_GAME, wfl::msg(), send_and_record_server_message(), send_data_sides(), sides_, and started_.

◆ q_type()

queue_type::type wesnothd::game::q_type ( ) const

inline

Definition at line 624 of file game.hpp.

References queue_type_.

◆ queue_id()

int wesnothd::game::queue_id ( )

inline

Definition at line 80 of file game.hpp.

References queue_id_.

◆ record_data()

void wesnothd::game::record_data ( std::unique_ptr< simple_wml::document > data )

Records a WML document in the game's history.

Parameters

data	The WML document to record.

Definition at line 1861 of file game.cpp.

References data, and history_.

Referenced by change_controller(), handle_controller_choice(), handle_random_choice(), process_turn(), and send_and_record_server_message().

◆ remove_player()

bool wesnothd::game::remove_player	(	player_iterator	player,
		const bool	disconnect = `false`,
		const bool	destruct = `false`
	)

Removes a user from the game.

Parameters

player	The player to remove.
disconnect	If the player disconnected from the server entirely.
destruct	If the game is ending as well.

Returns: True if the player's removal ends the game. That is, if there are no more players or the host left on a not yet started game.

Definition at line 1449 of file game.cpp.

References simple_wml::node::add_child(), change_controller(), current_turn(), db_id_, DBG_GAME, debug_player_info(), utils::erase(), ERR_GAME, string_enums::enum_base< Definition >::get_string(), id_, is_member(), is_observer(), is_player(), LOG_GAME, name_, notify_new_host(), game_config::images::observer, observers_, simple_wml::document::output(), owner_, player_connections_, players_, players_not_advanced_, wesnothd::player::PLAYING, simple_wml::document::root(), send_and_record_server_message(), send_observerquit(), send_server_message_to_all(), wesnothd::server::send_to_player(), send_user_list(), simple_wml::node::set_attr_dup(), side_controllers_, sides_, started_, termination_reason(), and username().

Referenced by ban_user(), kick_member(), and ~game().

◆ reset_last_synced_context_id()

void wesnothd::game::reset_last_synced_context_id ( )

inline

Reset the internal counter for choice requests made by clients to the server.

Definition at line 600 of file game.hpp.

References last_choice_request_id_.

◆ reset_sides()

void wesnothd::game::reset_sides ( )

private

calculates the initial value for sides_, side_controllerds_, nsides_

Definition at line 411 of file game.cpp.

References get_sides_list(), nsides_, side_controllers_, and sides_.

Referenced by update_side_data().

◆ save_replay()

void wesnothd::game::save_replay ( )

Move the level information and recorded history into a replay file and save it.

Definition at line 1805 of file game.cpp.

References simple_wml::document::child(), DBG_GAME, e, ERR_GAME, filename, get_replay_filename(), h, history_, simple_wml::INIT_STATIC, level_, name_, simple_wml::node_to_string(), filesystem::ostream_file(), simple_wml::document::output(), replay_save_path_, save_replays_, simple_wml::document::set_attr_dup(), started_, and WRN_CONFIG.

Referenced by ~game().

◆ send_and_record_server_message() [1/2]

void wesnothd::game::send_and_record_server_message	(	const char *	message,
		utils::optional< player_iterator >	exclude = `{}`
	)

Send data to all players in this game except 'exclude'.

Also record this data for the replay.

Parameters

message	The message to send.
exclude	The players to not send the message to.

Definition at line 1954 of file game.cpp.

References record_data(), send_data(), send_server_message(), and started_.

Referenced by add_player(), ban_user(), change_controller(), handle_choice(), handle_controller_choice(), kick_member(), mute_all_observers(), mute_observer(), notify_new_host(), perform_controller_tweaks(), process_turn(), process_whiteboard(), remove_player(), start_game(), transfer_side_control(), unban_user(), and unmute_observer().

◆ send_and_record_server_message() [2/2]

void wesnothd::game::send_and_record_server_message	(	const std::string &	message,
		utils::optional< player_iterator >	exclude = `{}`
	)

inline

send_and_record_server_message

Definition at line 423 of file game.hpp.

◆ send_chat_history()

void wesnothd::game::send_chat_history ( player_iterator sock ) const

private

Definition at line 1764 of file game.cpp.

References chat_history_, h, and wesnothd::server::send_to_player().

Referenced by add_player().

◆ send_data()

void wesnothd::game::send_data	(	simple_wml::document &	data,
		utils::optional< player_iterator >	exclude = `{}`
	)

Send data to all players and observers except those excluded.

Parameters

data	The data to send.
exclude	The players/observers to not send the data to.

Definition at line 1656 of file game.cpp.

References all_game_users(), data, and send_to_players().

Referenced by add_player(), change_controller_type(), handle_controller_choice(), handle_random_choice(), process_message(), process_turn(), send_and_record_server_message(), send_observerjoins(), send_observerquit(), send_server_message_to_all(), send_user_list(), and transfer_side_control().

◆ send_data_sides()

void wesnothd::game::send_data_sides	(	simple_wml::document &	data,
		const simple_wml::string_span &	sides,
		utils::optional< player_iterator >	exclude = `{}`
	)

private

Sends a document to the provided list of sides.

Parameters

data	The data to be sent to the provided sides.
sides	A comma sperated list of side numbers to which the document should be sent.
exclude	Players to not send the data to.

Definition at line 1661 of file game.cpp.

References data, DBG_GAME, players_, and send_to_players().

Referenced by process_turn(), and process_whiteboard().

◆ send_history()

void wesnothd::game::send_history ( player_iterator sock ) const

private

Definition at line 1737 of file game.cpp.

References e, h, history_, simple_wml::INIT_STATIC, wesnothd::server::send_to_player(), and WRN_CONFIG.

Referenced by add_player(), and load_next_scenario().

◆ send_leave_game()

void wesnothd::game::send_leave_game ( player_iterator user ) const

private

Tells a player to leave the game.

Parameters

user	The player leaving the game.

Definition at line 785 of file game.cpp.

References simple_wml::INIT_COMPRESSED, and wesnothd::server::send_to_player().

Referenced by ban_user(), and kick_member().

◆ send_muted_observers()

void wesnothd::game::send_muted_observers ( player_iterator user ) const

private

Sends a message either stating that all observers are muted or listing the observers that are muted.

Parameters

user	The player to send the message to.

Definition at line 700 of file game.cpp.

References all_observers_muted_, list_users(), muted_observers_, and send_server_message().

Referenced by mute_observer().

◆ send_observerjoins()

void wesnothd::game::send_observerjoins ( utils::optional< player_iterator > player = {} )

private

Send a document per observer in the game.

If player is blank, send these documents to everyone, else send them to just the observer who joined.

Parameters

player The observer who joined.

Definition at line 1705 of file game.cpp.

References config::add_child(), cfg, observers_, send_data(), and wesnothd::server::send_to_player().

Referenced by add_player(), load_next_scenario(), and start_game().

◆ send_observerquit()

void wesnothd::game::send_observerquit ( player_iterator observer )

private

Definition at line 1725 of file game.cpp.

References simple_wml::node::add_child(), game_config::images::observer, simple_wml::document::root(), send_data(), and simple_wml::node::set_attr_dup().

Referenced by remove_player(), and transfer_side_control().

◆ send_server_message() [1/2]

void wesnothd::game::send_server_message	(	const char *	message,
		utils::optional< player_iterator >	player = `{}`,
		simple_wml::document *	doc = `nullptr`
	)		const

Send a server message to the specified player.

Parameters

message	The message to send.
player	The player to send the message to. If empty then the message is not sent.
doc	The document to create the message in. If nullptr then a new document is created.

Definition at line 1972 of file game.cpp.

References config::add_child(), simple_wml::node::add_child(), cfg, wfl::msg(), simple_wml::document::root(), wesnothd::server::send_to_player(), chrono::serialize_timestamp(), and started_.

Referenced by add_player(), ban_user(), kick_member(), mute_observer(), process_turn(), send_and_record_server_message(), send_muted_observers(), send_server_message_to_all(), transfer_side_control(), unban_user(), and unmute_observer().

◆ send_server_message() [2/2]

void wesnothd::game::send_server_message	(	const std::string &	message,
		utils::optional< player_iterator >	player = `{}`,
		simple_wml::document *	doc = `nullptr`
	)		const

inline

send_server_message

Definition at line 406 of file game.hpp.

◆ send_server_message_to_all() [1/2]

void wesnothd::game::send_server_message_to_all	(	const char *	message,
		utils::optional< player_iterator >	exclude = `{}`
	)

Sends a message to all players in this game that aren't excluded.

Parameters

message	The message to send.
exclude	The players to not send the message to.

Definition at line 1965 of file game.cpp.

References send_data(), and send_server_message().

Referenced by load_next_scenario(), and remove_player().

◆ send_server_message_to_all() [2/2]

void wesnothd::game::send_server_message_to_all	(	const std::string &	message,
		utils::optional< player_iterator >	exclude = `{}`
	)

inline

send_server_message_to_all

Definition at line 389 of file game.hpp.

◆ send_taken_side()

bool wesnothd::game::send_taken_side	(	simple_wml::document &	cfg,
		const simple_wml::node *	side
	)		const

private

Tell the host who owns a side.

Parameters

cfg	The document to send to the host.
side	The side information to send.

Returns: True if the document was sent, false otherwise.

Definition at line 349 of file game.cpp.

References cfg, owner_, wesnothd::server::send_to_player(), and sides_.

Referenced by take_side().

◆ send_to_players()

template<typename Container >

void wesnothd::game::send_to_players	(	simple_wml::document &	data,
		const Container &	players,
		utils::optional< player_iterator >	exclude = `{}`
	)

Send data to all players except those excluded.

For example, to send a message to all players except the player who typed the original message.

Parameters

data	The data to send.
players	The players to send the data to.
exclude	The player from players to not send the data to.

Definition at line 1647 of file game.cpp.

References data, and wesnothd::server::send_to_player().

Referenced by process_turn(), send_data(), and send_data_sides().

◆ send_user_list()

void wesnothd::game::send_user_list ( utils::optional< player_iterator > exclude = {} )

private

Function to send a list of users to all clients.

Only sends data if the game is initialized but not yet started.

Parameters

exclude The players to not send the list of users to.

Definition at line 1559 of file game.cpp.

References simple_wml::node::add_child(), all_game_users(), cfg, is_observer(), is_owner(), send_data(), simple_wml::node::set_attr(), simple_wml::node::set_attr_dup(), and started_.

Referenced by add_player(), and remove_player().

◆ set_description()

void wesnothd::game::set_description ( simple_wml::node * desc )

Set the game's description.

Also set the game as requiring a password if a password is set.

Parameters

desc	The node containing the game's description.

Definition at line 1877 of file game.cpp.

References description_, password_, and simple_wml::node::set_attr().

◆ set_name_bans()

void wesnothd::game::set_name_bans ( const std::vector< std::string > name_bans )

inline

Set a list of usernames that should all be banned from joining the game.

Parameters

name_bans The list of usernames.

Definition at line 529 of file game.hpp.

References name_bans_.

◆ set_password()

void wesnothd::game::set_password ( const std::string & passwd )

inline

Sets the password required to access the game.

Parameters

passwd The password to set.

Definition at line 519 of file game.hpp.

References password_.

◆ set_termination_reason()

void wesnothd::game::set_termination_reason ( const std::string & reason )

Sets the termination reason for this game.

Parameters

reason The termination reason.

Definition at line 1885 of file game.cpp.

References termination_.

◆ start_game()

void wesnothd::game::start_game ( player_iterator starter )

Starts the game (if a new game) or starts the next scenario of an MP campaign.

Parameters

starter The game's host.

Definition at line 263 of file game.cpp.

References simple_wml::node::child(), clear_chat_history(), clear_history(), current_side_index_, current_turn_, db_id_, DBG_GAME, debug_sides_info(), wesnothd::get_multiplayer(), get_sides_list(), id_, level_, list_users(), LOG_GAME, wfl::msg(), name_, next_side_index_, nsides_, num_turns_, players_, simple_wml::document::root(), send_and_record_server_message(), send_observerjoins(), sides_, started_, starting_pos(), and update_turn_data().

◆ started()

bool wesnothd::game::started ( ) const

inline

Returns: Whether this game has started yet.

Definition at line 197 of file game.hpp.

References started_.

◆ starting_pos() [1/2]

static const simple_wml::node* wesnothd::game::starting_pos ( const simple_wml::node & data )

inlinestatic

The const version.

Parameters

data	The data describing the level for a game.

Returns: The [scenario] child node if it exists, else the [snapshot] child if it exists, else data.

Definition at line 175 of file game.hpp.

References data.

◆ starting_pos() [2/2]

static simple_wml::node* wesnothd::game::starting_pos ( simple_wml::node & data )

inlinestatic

The non-const version.

Parameters

data	The data describing the level for a game.

Returns: The [scenario] child node if it exists, else the [snapshot] child if it exists, else data.

Definition at line 158 of file game.hpp.

References data.

Referenced by get_replay_filename(), get_sides_list(), wesnothd::server::handle_player_in_game(), and start_game().

◆ take_side()

bool wesnothd::game::take_side ( player_iterator user )

private

Figures out which side to take and tells that side to the game owner.

The owner then should send a [scenario_diff] that implements the side change and a subsequent update_side_data() call makes it actually happen. First we look for a side where save_id= or current_player= matches the new user's name then we search for the first controller=human or reserved side.

Parameters

user	The player taking a side.

Returns: True if the side was taken, false otherwise.

Definition at line 370 of file game.cpp.

References cfg, DBG_GAME, get_sides_list(), send_taken_side(), and started_.

Referenced by add_player().

◆ termination_reason()

const std::string& wesnothd::game::termination_reason ( ) const

inline

Provides the reason the game was ended.

Returns: Either that the game was aborted (after starting), not started, or has some other reason set.

Definition at line 556 of file game.hpp.

References started_, and termination_.

Referenced by wesnothd::server::cleanup_game(), and remove_player().

◆ transfer_side_control()

void wesnothd::game::transfer_side_control	(	player_iterator	player,
		const simple_wml::node &	cfg
	)

Lets a player owning a side give it to another player or observer.

Parameters

player	The player owning the side.
cfg	The node containing the transfer information.

Definition at line 494 of file game.cpp.

References simple_wml::node::add_child(), cfg, change_controller(), change_controller_type(), DBG_GAME, simple_wml::string_span::empty(), utils::erase(), utils::find(), find_user(), string_enums::enum_base< Definition >::get_enum(), get_sides_list(), is_member(), is_observer(), is_player(), wfl::msg(), observers_, wesnothd::player::OBSERVING, owner_, players_, wesnothd::player::PLAYING, simple_wml::document::root(), send_and_record_server_message(), send_data(), send_observerquit(), send_server_message(), simple_wml::node::set_attr_dup(), side_controllers_, sides_, utf8::size(), simple_wml::string_span::to_string(), and username().

Referenced by process_turn().

◆ unban_user()

void wesnothd::game::unban_user	(	const simple_wml::node &	unban,
		player_iterator	unbanner
	)

Unban a user by name.

The user does not need to be in this game but logged in.

Parameters

unban	The user to unban.
unbanner	The player doing the unbanning.

Definition at line 865 of file game.cpp.

References bans_, db_id_, utils::erase(), find_user(), id_, LOG_GAME, name_, name_bans_, owner_, player_is_banned(), send_and_record_server_message(), send_server_message(), and username().

◆ unmute_observer()

void wesnothd::game::unmute_observer	(	const simple_wml::node &	unmute,
		player_iterator	unmuter
	)

Unmute an observer or unmute all currently muted observers if no name is given.

Parameters

unmute	The observer to unmute. Empty if unmuting all observers.
unmuter	The player doing the unmuting.

Definition at line 753 of file game.cpp.

References db_id_, utils::erase(), find_user(), id_, is_muted_observer(), is_observer(), LOG_GAME, muted_observers_, name_, owner_, send_and_record_server_message(), send_server_message(), and username().

◆ update_side_data()

void wesnothd::game::update_side_data ( )

Resets the side configuration according to the scenario data.

Definition at line 422 of file game.cpp.

References all_game_users(), DBG_GAME, debug_player_info(), string_enums::enum_base< Definition >::get_enum(), get_sides_list(), observers_, wesnothd::player::OBSERVING, owner_, players_, wesnothd::player::PLAYING, reset_sides(), side_controllers_, sides_, and started_.

Referenced by perform_controller_tweaks().

◆ update_turn_data()

void wesnothd::game::update_turn_data ( )

private

Set or update the current and max turn values in the game's description.

Definition at line 1352 of file game.cpp.

References simple_wml::node::child_or_add(), current_turn(), description_, description_for_writing(), num_turns_, and simple_wml::node::set_attr_int().

Referenced by init_turn(), and start_game().

◆ username()

std::string wesnothd::game::username ( player_iterator pl ) const

private

Parameters

pl	The player.

Returns: The player's username.

Definition at line 188 of file game.cpp.

Referenced by ban_user(), kick_member(), mute_observer(), notify_new_host(), perform_controller_tweaks(), process_turn(), remove_player(), transfer_side_control(), unban_user(), and unmute_observer().

Member Data Documentation

◆ all_observers_muted_

bool wesnothd::game::all_observers_muted_

private

Whether all observers should be treated as muted.

Definition at line 956 of file game.hpp.

Referenced by all_observers_muted(), is_muted_observer(), mute_all_observers(), and send_muted_observers().

◆ bans_

std::vector<std::string> wesnothd::game::bans_

private

List of banned IPs.

Definition at line 959 of file game.hpp.

Referenced by ban_user(), player_is_banned(), and unban_user().

◆ chat_history_

std::vector<std::unique_ptr<simple_wml::document> > wesnothd::game::chat_history_

mutableprivate

Replay chat history data.

Definition at line 936 of file game.hpp.

Referenced by clear_chat_history(), process_message(), and send_chat_history().

◆ current_side_index_

int wesnothd::game::current_side_index_

private

The index of the current side.

The side number is current_side_index_+1.

Definition at line 947 of file game.hpp.

Referenced by current_side(), end_turn(), init_turn(), process_turn(), and start_game().

◆ current_turn_

int wesnothd::game::current_turn_

private

The game's current turn.

Definition at line 945 of file game.hpp.

Referenced by current_turn(), init_turn(), process_change_turns_wml(), process_turn(), and start_game().

◆ db_id_

int wesnothd::game::db_id_

private

Used for unique identification of games played in the database.

Necessary since for MP campaigns multiple scenarios can be played within the same game instance and we need a unique ID per scenario played, not per game instance.

Definition at line 884 of file game.hpp.

Referenced by add_player(), ban_user(), db_id(), debug_player_info(), debug_sides_info(), get_replay_filename(), kick_member(), mute_observer(), next_db_id(), perform_controller_tweaks(), process_turn(), remove_player(), start_game(), unban_user(), and unmute_observer().

◆ db_id_num

int wesnothd::game::db_id_num = 1

staticprivate

Incremented to retrieve a unique ID per wesnothd instance for game instances within the database.

Definition at line 878 of file game.hpp.

Referenced by next_db_id().

◆ description_

simple_wml::node* wesnothd::game::description_

private

Pointer to the game's description in the games_and_users_list_.

Definition at line 939 of file game.hpp.

Referenced by changed_description(), describe_slots(), description(), description_for_writing(), get_vacant_slots(), set_description(), and update_turn_data().

◆ description_updated_

bool wesnothd::game::description_updated_

private

Set to true whenever description_ was changed that an update needs to be sent to clients.

Definition at line 942 of file game.hpp.

Referenced by changed_description(), and description_for_writing().

◆ history_

std::vector<std::unique_ptr<simple_wml::document> > wesnothd::game::history_

mutableprivate

Replay data.

Definition at line 934 of file game.hpp.

Referenced by clear_history(), record_data(), save_replay(), and send_history().

◆ id_

int wesnothd::game::id_

private

This game's ID within wesnothd.

Definition at line 873 of file game.hpp.

Referenced by add_player(), ban_user(), debug_player_info(), debug_sides_info(), game(), id(), kick_member(), mute_observer(), perform_controller_tweaks(), process_turn(), remove_player(), start_game(), unban_user(), and unmute_observer().

◆ id_num

int wesnothd::game::id_num = 1

staticprivate

Incremented to retrieve a unique ID for game instances within wesnothd.

Definition at line 871 of file game.hpp.

◆ last_choice_request_id_

int wesnothd::game::last_choice_request_id_

private

The ID of the last request received from a client.

New requests should never have a lower value than this.

Definition at line 984 of file game.hpp.

Referenced by handle_choice(), handle_controller_choice(), handle_random_choice(), and reset_last_synced_context_id().

◆ level_

simple_wml::document wesnothd::game::level_

private

The current scenario data.

WRONG! This contains the initial state or the state from which the game was loaded from. Using this to make assumptions about the current gamestate is extremely dangerous and should especially not be done for anything that can be nodified by wml (especially by [modify_side]), like team_name, controller ... in [side].

FIXME: move every code here that uses this object to query those information to the clients. But note that there are some checks (like controller == null) that are definitely needed by the server and in this case we should try to modify the client to inform the server if a change of those properties occur. Ofc we shouldn't update level_ then, but rather store that information in a separate object (like in side_controllers_).

Definition at line 931 of file game.hpp.

Referenced by add_player(), allow_observers(), get_replay_filename(), get_scenario_id(), get_sides_list(), is_reload(), level(), level_init(), load_next_scenario(), save_replay(), and start_game().

◆ muted_observers_

user_vector wesnothd::game::muted_observers_

private

A vector of muted observers.

Definition at line 900 of file game.hpp.

Referenced by is_muted_observer(), mute_observer(), send_muted_observers(), and unmute_observer().

◆ name_

std::string wesnothd::game::name_

private

The name of the game.

Definition at line 887 of file game.hpp.

Referenced by add_player(), ban_user(), game(), kick_member(), mute_observer(), name(), remove_player(), save_replay(), start_game(), unban_user(), and unmute_observer().

◆ name_bans_

std::vector<std::string> wesnothd::game::name_bans_

private

List of banned usernames.

Definition at line 961 of file game.hpp.

Referenced by ban_user(), player_is_banned(), set_name_bans(), and unban_user().

◆ next_side_index_

int wesnothd::game::next_side_index_

private

after [end_turn] was received, this contains the side for who we accept [init_side].

-1 if we currently don't accept [init_side] because the current player didn't end his turn yet.

Definition at line 952 of file game.hpp.

Referenced by end_turn(), get_next_side_index(), init_turn(), and start_game().

◆ nsides_

int wesnothd::game::nsides_

private

Number of sides in the current scenario.

Definition at line 909 of file game.hpp.

Referenced by get_next_nonempty(), handle_add_side_wml(), process_turn(), reset_sides(), and start_game().

◆ num_turns_

int wesnothd::game::num_turns_

private

The maximum number of turns before the game ends.

Definition at line 954 of file game.hpp.

Referenced by process_change_turns_wml(), start_game(), and update_turn_data().

◆ observers_

user_vector wesnothd::game::observers_

private

A vector of observers (members not owning a side).

Definition at line 898 of file game.hpp.

Referenced by add_player(), all_game_users(), debug_player_info(), emergency_cleanup(), is_observer(), nobservers(), process_turn(), remove_player(), send_observerjoins(), transfer_side_control(), and update_side_data().

◆ owner_

player_iterator wesnothd::game::owner_

private

The game host or later owner (if the host left).

Definition at line 892 of file game.hpp.

Referenced by ban_user(), game(), handle_choice(), is_legal_command(), is_owner(), kick_member(), mute_observer(), new_scenario(), notify_new_host(), perform_controller_tweaks(), process_turn(), remove_player(), send_taken_side(), transfer_side_control(), unban_user(), unmute_observer(), and update_side_data().

◆ password_

std::string wesnothd::game::password_

private

The password needed to join the game.

Definition at line 889 of file game.hpp.

Referenced by has_password(), password_matches(), set_description(), and set_password().

◆ player_connections_

player_connections& wesnothd::game::player_connections_

private

Definition at line 866 of file game.hpp.

Referenced by find_user(), and remove_player().

◆ players_

user_vector wesnothd::game::players_

private

A vector of players (members owning a side).

Definition at line 895 of file game.hpp.

Referenced by add_player(), all_game_users(), debug_player_info(), emergency_cleanup(), game(), is_player(), nplayers(), remove_player(), send_data_sides(), start_game(), transfer_side_control(), and update_side_data().

◆ players_not_advanced_

std::set<const player_record*> wesnothd::game::players_not_advanced_

private

in multiplayer campaigns it can happen that some players are still in the previous scenario keep track of those players because processing certain input from those side wil lead to error (oos)

Definition at line 968 of file game.hpp.

Referenced by handle_choice(), load_next_scenario(), new_scenario(), and remove_player().

◆ queue_id_

int wesnothd::game::queue_id_

private

Which server-side queue this game came from.

Definition at line 990 of file game.hpp.

Referenced by is_open_queue_game(), and queue_id().

◆ queue_type_

queue_type::type wesnothd::game::queue_type_

private

Whether this game was created manually or by joining a queue.

Definition at line 987 of file game.hpp.

Referenced by is_open_queue_game(), and q_type().

◆ replay_save_path_

std::string wesnothd::game::replay_save_path_

private

Where to save the replay of this game.

Definition at line 976 of file game.hpp.

Referenced by save_replay().

◆ rng_

randomness::mt_rng wesnothd::game::rng_

private

A wrapper for mersenne twister rng which generates randomness for this game.

Definition at line 979 of file game.hpp.

Referenced by handle_random_choice().

◆ save_replays_

bool wesnothd::game::save_replays_

private

Whether to save a replay of this game.

Definition at line 974 of file game.hpp.

Referenced by save_replay().

◆ server

wesnothd::server& wesnothd::game::server

private

The wesnothd server instance this game exists on.

Definition at line 865 of file game.hpp.

◆ side_controllers_

std::vector<side_controller::type> wesnothd::game::side_controllers_

private

A vector containiner the controller type for each side.

Definition at line 906 of file game.hpp.

Referenced by change_controller(), change_controller_type(), debug_sides_info(), get_next_nonempty(), handle_add_side_wml(), handle_controller_choice(), remove_player(), reset_sides(), transfer_side_control(), and update_side_data().

◆ sides_

side_vector wesnothd::game::sides_

private

A vector of side owners.

Definition at line 903 of file game.hpp.

Referenced by change_controller(), controls_side(), describe_slots(), get_side_player(), handle_add_side_wml(), handle_controller_choice(), load_next_scenario(), perform_controller_tweaks(), process_turn(), process_whiteboard(), remove_player(), reset_sides(), send_taken_side(), start_game(), transfer_side_control(), and update_side_data().

◆ started_

bool wesnothd::game::started_

private

Whether the game has been started or not.

Definition at line 911 of file game.hpp.

Referenced by add_player(), change_controller(), describe_slots(), handle_choice(), is_open_queue_game(), load_next_scenario(), new_scenario(), process_change_turns_wml(), process_turn(), process_whiteboard(), remove_player(), save_replay(), send_and_record_server_message(), send_server_message(), send_user_list(), start_game(), started(), take_side(), termination_reason(), and update_side_data().

◆ termination_

std::string wesnothd::game::termination_

private

The reason the game ended.

Definition at line 971 of file game.hpp.

Referenced by set_termination_reason(), and termination_reason().

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

server/wesnothd/game.hpp
server/wesnothd/game.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ game() [1/2]

◆ ~game()

◆ game() [2/2]

Member Function Documentation

◆ add_player()

◆ all_game_users()

◆ all_observers_muted()

◆ allow_observers()

◆ ban_user()

◆ change_controller()

◆ change_controller_type()

◆ changed_description()

◆ clear_chat_history()

◆ clear_history()

◆ controls_side()

◆ current_player()

◆ current_side()

◆ current_turn()

◆ db_id()

◆ debug_player_info()

◆ debug_sides_info()

◆ describe_slots()

◆ description()

◆ description_for_writing()

◆ emergency_cleanup()

◆ end_turn()

◆ find_user()

◆ get_next_nonempty()

◆ get_next_side_index()

◆ get_replay_filename()

◆ get_scenario_id()

◆ get_side_player()

◆ get_sides_list()

◆ get_vacant_slots()

◆ handle_add_side_wml()

◆ handle_choice()

◆ handle_controller_choice()

◆ handle_random_choice()

◆ has_password()

◆ has_same_ip()

◆ id()

◆ init_turn()

◆ is_current_player()

◆ is_legal_command()

◆ is_member()

◆ is_muted_observer()

◆ is_observer()

◆ is_open_queue_game()

◆ is_owner()

◆ is_player()

◆ is_reload()

◆ kick_member()

◆ level()

◆ level_init()

◆ list_users()

◆ load_next_scenario()

◆ mute_all_observers()

◆ mute_observer()

◆ name()

◆ new_scenario()

◆ next_db_id()

◆ nobservers()

◆ notify_new_host()

◆ nplayers()

◆ operator=()

◆ password_matches()

◆ perform_controller_tweaks()

◆ player_is_banned()

◆ process_change_turns_wml()

◆ process_message()

◆ process_turn()

◆ process_whiteboard()

◆ q_type()