The Battle for Wesnoth: turn_info Class Reference

The Battle for Wesnoth 1.17.23+dev

TODO: rename this class since it isn't that much related to turns. More...

#include <playturn.hpp>

Public Types
enum	PROCESS_DATA_RESULT { PROCESS_CONTINUE , PROCESS_RESTART_TURN , PROCESS_END_TURN , PROCESS_END_LINGER , PROCESS_FOUND_DEPENDENT , PROCESS_CANNOT_HANDLE , PROCESS_END_LEVEL }

Public Member Functions
	turn_info (replay_network_sender &network_sender, playturn_network_adapter &network_reader)

	~turn_info ()

PROCESS_DATA_RESULT	sync_network ()

void	send_data ()

PROCESS_DATA_RESULT	process_network_data (const config &cfg, bool chat_only=false)

PROCESS_DATA_RESULT	process_network_data_from_reader ()

events::generic_event &	host_transfer ()

Static Public Member Functions
static PROCESS_DATA_RESULT	replay_to_process_data_result (REPLAY_RETURN replayreturn)

Private Member Functions
PROCESS_DATA_RESULT	handle_turn (const config &t, bool chat_only=false)

void	do_save ()

Static Private Member Functions
static void	change_side_controller (int side, const std::string &player)

Private Attributes
replay_network_sender &	replay_sender_

events::generic_event	host_transfer_

playturn_network_adapter &	network_reader_

Detailed Description

TODO: rename this class since it isn't that much related to turns.

Definition at line 28 of file playturn.hpp.

Member Enumeration Documentation

◆ PROCESS_DATA_RESULT

enum turn_info::PROCESS_DATA_RESULT

Enumerator
PROCESS_CONTINUE
PROCESS_RESTART_TURN
PROCESS_END_TURN
PROCESS_END_LINGER	When the host uploaded the next scenario this is returned.
PROCESS_FOUND_DEPENDENT	When we couldn't process the network data because we found a dependent command, this should only happen if we were called playmp_controller::from handle_generic_event -> sync_network.
PROCESS_CANNOT_HANDLE	when we couldn't handle the given action currently.
PROCESS_END_LEVEL	We found a player action in the replay that caused the game to end.

Definition at line 37 of file playturn.hpp.

Constructor & Destructor Documentation

◆ turn_info()

turn_info::turn_info	(	replay_network_sender &	network_sender,
		playturn_network_adapter &	network_reader
	)

Definition at line 50 of file playturn.cpp.

◆ ~turn_info()

turn_info::~turn_info ( )

Definition at line 57 of file playturn.cpp.

Member Function Documentation

◆ change_side_controller()

void turn_info::change_side_controller	(	int	side,
		const std::string &	player
	)

staticprivate

Definition at line 385 of file playturn.cpp.

References config::add_child(), resources::controller, and play_controller::send_to_wesnothd().

Referenced by process_network_data().

◆ do_save()

void turn_info::do_save ( )

private

Definition at line 106 of file playturn.cpp.

References resources::controller, and play_controller::do_autosave().

Referenced by process_network_data().

◆ handle_turn()

turn_info::PROCESS_DATA_RESULT turn_info::handle_turn	(	const config &	t,
		bool	chat_only = `false`
	)

private

Todo:: FIXME: Check what commands we execute when it's our turn!

Definition at line 90 of file playturn.cpp.

References replay::add_config(), do_replay(), replay::MARK_AS_SENT, PROCESS_CANNOT_HANDLE, resources::recorder, replay_to_process_data_result(), and t.

Referenced by process_network_data().

◆ host_transfer()

events::generic_event& turn_info::host_transfer ( )

inline

Definition at line 62 of file playturn.hpp.

References host_transfer_.

Referenced by playmp_controller::playmp_controller(), and playmp_controller::~playmp_controller().

◆ process_network_data()

turn_info::PROCESS_DATA_RESULT turn_info::process_network_data	(	const config &	cfg,
		bool	chat_only = `false`
	)

Definition at line 128 of file playturn.cpp.

References _(), display_chat_manager::add_chat_message(), display_chat_manager::add_observer(), config::all_children_count(), config::attribute_range(), change_side_controller(), resources::controller, team::current_player(), config::debug(), do_save(), ERR_NW, resources::gameboard, resources::gamedata, game_display::get_chat_manager(), string_enums::enum_base< Definition >::get_enum(), display::get_singleton(), game_display::get_singleton(), string_enums::enum_base< Definition >::get_string(), handle_turn(), config::has_attribute(), config::has_child(), host_transfer_, utf8::index(), team::is_local(), team::is_local_human(), display::labels(), config::mandatory_child(), preferences::message_bell(), events::chat_handler::MESSAGE_PRIVATE, events::chat_handler::MESSAGE_PUBLIC, game_data::next_scenario(), events::generic_event::notify_observers(), game_config::images::observer, play_controller::on_not_observer(), config::optional_child(), preferences::options(), game_display::playing_side(), PROCESS_CANNOT_HANDLE, PROCESS_CONTINUE, PROCESS_END_LINGER, PROCESS_RESTART_TURN, display::queue_rerender(), map_labels::recalculate_labels(), resources::recorder, display_chat_manager::remove_observer(), gui2::dialogs::simple_item_selector::selected_index(), gui2::dialogs::simple_item_selector::set_single_button(), display::set_team(), gui2::dialogs::modal_dialog::show(), game_board::side_change_controller(), game_board::side_drop_to(), utf8::size(), t, game_board::teams(), throw_quit_game_exception(), VGETTEXT, display::viewing_team(), and resources::whiteboard.

Referenced by playmp_controller::play_linger_turn(), playmp_controller::process_network_data(), process_network_data_from_reader(), and sync_network().

◆ process_network_data_from_reader()

turn_info::PROCESS_DATA_RESULT turn_info::process_network_data_from_reader ( )

Definition at line 113 of file playturn.cpp.

References config::clear(), network_reader_, PROCESS_CONTINUE, process_network_data(), and playturn_network_adapter::read().

Referenced by playmp_controller::wait_for_upload().

◆ replay_to_process_data_result()

turn_info::PROCESS_DATA_RESULT turn_info::replay_to_process_data_result ( REPLAY_RETURN replayreturn )

static

Definition at line 394 of file playturn.cpp.

References PROCESS_CONTINUE, PROCESS_END_LEVEL, PROCESS_END_TURN, PROCESS_FOUND_DEPENDENT, REPLAY_FOUND_DEPENDENT, REPLAY_FOUND_END_LEVEL, REPLAY_FOUND_END_TURN, and REPLAY_RETURN_AT_END.

Referenced by handle_turn(), playmp_controller::process_network_data(), and sync_network().

◆ send_data()

◆ sync_network()

turn_info::PROCESS_DATA_RESULT turn_info::sync_network ( )

Definition at line 61 of file playturn.cpp.

References config::clear(), resources::controller, do_replay(), network_reader_, PROCESS_CONTINUE, process_network_data(), playturn_network_adapter::read(), replay_to_process_data_result(), and send_data().

Referenced by playsingle_controller::play_ai_turn(), and playmp_controller::pull_remote_choice().

Member Data Documentation

◆ host_transfer_

events::generic_event turn_info::host_transfer_

private

Definition at line 73 of file playturn.hpp.

Referenced by host_transfer(), and process_network_data().

◆ network_reader_

playturn_network_adapter& turn_info::network_reader_

private

Definition at line 75 of file playturn.hpp.

Referenced by process_network_data_from_reader(), and sync_network().

◆ replay_sender_

replay_network_sender& turn_info::replay_sender_

private

Definition at line 71 of file playturn.hpp.

Referenced by send_data().

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