#include <playsingle_controller.hpp>

Inheritance diagram for playsingle_controller:

Classes
class	hotkey_handler

Public Member Functions
	playsingle_controller (const config &level, saved_game &state_of_game, const config &game_config, const tdata_cache &tdata, CVideo &video, bool skip_replay)

virtual	~playsingle_controller ()

LEVEL_RESULT	play_scenario (const config &level)

void	play_scenario_init ()

void	play_scenario_main_loop ()

virtual void	handle_generic_event (const std::string &name)

virtual void	check_objectives ()

virtual void	on_not_observer ()

virtual void	maybe_linger ()

void	end_turn ()

void	force_end_turn ()

std::string	describe_result () const

bool	get_player_type_changed () const

void	set_player_type_changed ()

virtual bool	should_return_to_play_side ()

replay_controller *	get_replay_controller ()

bool	is_replay ()

void	enable_replay (bool is_unit_test=false)

void	on_replay_end (bool is_unit_test)

Public Member Functions inherited from play_controller
	play_controller (const config &level, saved_game &state_of_game, const config &game_config, const tdata_cache &tdata, CVideo &video, bool skip_replay)

virtual	~play_controller ()

bool	can_undo () const

bool	can_redo () const

void	undo ()

void	redo ()

void	load_game ()

void	save_game ()

void	save_game_auto (const std::string &filename)

void	save_replay ()

void	save_replay_auto (const std::string &filename)

void	save_map ()

void	init_side_begin ()

void	maybe_do_init_side ()
	Called by turn_info::process_network_data() or init_side() to call do_init_side() if necessary. More...

void	do_init_side ()
	Called by replay handler or init_side() to do actual work for turn change. More...

void	init_side_end ()

virtual void	process_oos (const std::string &msg) const
	Asks the user whether to continue on an OOS error. More...

void	set_end_level_data (const end_level_data &data)

void	reset_end_level_data ()

bool	is_regular_game_end () const

const end_level_data &	get_end_level_data_const () const

const std::vector< team > &	get_teams_const () const

const unit_map &	get_units_const () const

const gamemap &	get_map_const () const

const tod_manager &	get_tod_manager_const () const

bool	is_observer () const

game_state &	gamestate ()

const game_state &	gamestate () const

void	check_victory ()
	Checks to see if a side has won. More...

size_t	turn () const

int	current_side () const
	Returns the number of the side whose turn it is. More...

config	to_config () const
	Builds the snapshot config from members and their respective configs. More...

bool	is_skipping_replay () const

void	toggle_skipping_replay ()

bool	is_linger_mode () const

void	do_autosave ()

void	do_consolesave (const std::string &filename)

events::mouse_handler &	get_mouse_handler_base ()
	Get a reference to a mouse handler member a derived class uses. More...

events::menu_handler &	get_menu_handler ()

boost::shared_ptr< wb::manager >	get_whiteboard ()

const mp_game_settings &	get_mp_settings ()

const game_classification &	get_classification ()

int	get_server_request_number () const

void	increase_server_request_number ()

game_events::t_pump &	pump ()

int	get_ticks ()

virtual soundsource::manager *	get_soundsource_man ()
	Get (optionally) a soundsources manager a derived class uses. More...

virtual plugins_context *	get_plugins_context ()
	Get (optionally) a plugins context a derived class uses. More...

hotkey::command_executor *	get_hotkey_command_executor ()
	Get (optionally) a command executor to handle context menu events. More...

actions::undo_list &	get_undo_stack ()

bool	is_browsing () const override

bool	is_lingering () const

t_string	get_scenario_name ()

bool	get_disallow_recall ()

std::string	theme ()

void	maybe_throw_return_to_play_side ()

void	play_side ()

team &	current_team ()

const team &	current_team () const

bool	can_use_synced_wml_menu () const

std::set< std::string >	all_players () const

int	ticks () const

game_display &	get_display ()
	Get a reference to a display member a derived class uses. More...

void	update_savegame_snapshot () const

void	update_gui_to_player (const int team_index, const bool observe=false)
	Changes the UI for this client to the passed side index. More...

virtual bool	is_networked_mp () const

virtual void	send_to_wesnothd (const config &, const std::string &="unknown") const

virtual bool	recieve_from_wesnothd (config &) const

Public Member Functions inherited from controller_base
	controller_base (const config &game_config, CVideo &video)

virtual	~controller_base ()

void	play_slice (bool is_delay_enabled=true)

void	apply_keyboard_scroll (int x, int y)

void	set_scroll_up (bool on)

void	set_scroll_down (bool on)

void	set_scroll_left (bool on)

void	set_scroll_right (bool on)

Public Member Functions inherited from events::sdl_handler
virtual void	process_event ()

virtual void	draw ()

virtual void	volatile_draw ()

virtual void	volatile_undraw ()

virtual bool	requires_event_focus (const SDL_Event *=nullptr) const

virtual void	process_help_string (int, int)

virtual void	process_tooltip_string (int, int)

virtual void	join ()

virtual void	join (context &c)

virtual void	join_same (sdl_handler *parent)

virtual void	leave ()

virtual void	join_global ()

virtual void	leave_global ()

Public Member Functions inherited from events::observer
virtual	~observer ()

Public Member Functions inherited from quit_confirmation
	quit_confirmation (const std::function< bool()> &prompt=&quit_confirmation::default_prompt)

	~quit_confirmation ()

Protected Types
enum	END_TURN_STATE { END_TURN_NONE, END_TURN_REQUIRED, END_TURN_SYNCED }

Protected Member Functions
virtual void	play_side_impl ()

void	before_human_turn ()

void	show_turn_dialog ()

void	execute_gotos ()

virtual void	play_human_turn ()

virtual void	after_human_turn ()

void	end_turn_enable (bool enable)

void	play_ai_turn ()

virtual void	play_idle_loop ()

virtual void	do_idle_notification ()
	Will handle sending a networked notification in descendent classes. More...

virtual void	play_network_turn ()
	Will handle networked turns in descendent classes. More...

virtual void	init_gui ()

void	store_recalls ()

void	store_gold (bool obs=false)

void	linger ()

void	sync_end_turn ()

void	update_viewing_player ()

void	reset_replay ()

Protected Member Functions inherited from play_controller
void	play_slice_catch ()

bool	have_keyboard_focus ()
	Derived classes should override this to return false when arrow keys should not scroll the map, hotkeys not processed etc, for example when a textbox is active. More...

void	process_focus_keydown_event (const SDL_Event &event)
	Process keydown (only when the general map display does not have focus). More...

void	process_keydown_event (const SDL_Event &event)
	Process keydown (always). More...

void	process_keyup_event (const SDL_Event &event)
	Process keyup (always). More...

void	init_managers ()

void	fire_preload ()
	preload events cannot be synced More...

void	fire_prestart ()

void	fire_start ()

void	start_game ()

void	finish_side_turn ()

void	finish_turn ()

bool	enemies_visible () const

void	enter_textbox ()

void	tab ()

bool	is_team_visible (int team_num, bool observer) const

int	find_last_visible_team () const
	returns 0 if no such team was found. More...

actions::undo_list &	undo_stack ()

const actions::undo_list &	undo_stack () const

const std::string &	select_victory_music () const

const std::string &	select_defeat_music () const

void	set_victory_music_list (const std::string &list)

void	set_defeat_music_list (const std::string &list)

void	reset_gamestate (const config &level, int replay_pos)

virtual void	check_time_over ()

void	play_turn ()

Protected Member Functions inherited from controller_base
virtual std::vector< std::string >	additional_actions_pressed ()

bool	handle_scroll (int mousex, int mousey, int mouse_flags, double joystickx, double joysticky)
	Handle scrolling by keyboard, joystick and moving mouse near map edges. More...

void	handle_event (const SDL_Event &event)
	Process mouse- and keypress-events from SDL. More...

void	handle_window_event (const SDL_Event &)

virtual void	show_menu (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu, display &disp)

virtual void	execute_action (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu)

virtual bool	in_context_menu (hotkey::HOTKEY_COMMAND command) const

Protected Member Functions inherited from video2::draw_layering
	draw_layering (const bool auto_join=true)

virtual	~draw_layering ()

Protected Member Functions inherited from events::sdl_handler
	sdl_handler (const bool auto_join=true)

virtual	~sdl_handler ()

virtual std::vector < sdl_handler * >	handler_members ()

Protected Attributes
const cursor::setter	cursor_setter

gui::floating_textbox	textbox_info_

replay_network_sender	replay_sender_

playturn_network_adapter	network_reader_

turn_info	turn_data_

END_TURN_STATE	end_turn_

bool	skip_next_turn_

boost::scoped_ptr < replay_controller >	replay_

Protected Attributes inherited from play_controller
const tdata_cache &	tdata_

boost::scoped_ptr< game_state >	gamestate_

config	level_

saved_game &	saved_game_

boost::scoped_ptr < tooltips::manager >	tooltips_manager_

boost::shared_ptr< wb::manager >	whiteboard_manager_

boost::scoped_ptr < plugins_context >	plugins_context_

font::floating_label_context	labels_manager_

help::help_manager	help_manager_

events::mouse_handler	mouse_handler_

events::menu_handler	menu_handler_

boost::scoped_ptr< hotkey_handler >	hotkey_handler_

boost::scoped_ptr < soundsource::manager >	soundsources_manager_

persist_manager	persist_

boost::scoped_ptr< game_display >	gui_

boost::scoped_ptr < unit_experience_accelerator >	xp_mod_

boost::scoped_ptr< const statistics::scenario_context >	statistics_context_

boost::scoped_ptr< replay >	replay_

bool	skip_replay_

bool	linger_

bool	init_side_done_now_
	Whether we did init sides in this session (false = we did init sides before we reloaded the game). More...

bool	ignore_replay_errors_

bool	player_type_changed_

Protected Attributes inherited from controller_base
const config &	game_config_

CKey	key_

bool	scrolling_

bool	scroll_up_

bool	scroll_down_

bool	scroll_left_

bool	scroll_right_

joystick_manager	joystick_manager_

Additional Inherited Members
Static Public Member Functions inherited from controller_base
static const config &	get_theme (const config &game_config, std::string theme_name)

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 playsingle_controller.hpp.

Member Enumeration Documentation

enum playsingle_controller::END_TURN_STATE

protected

Enumerator
END_TURN_NONE	The turn was not ended yet.
END_TURN_REQUIRED	And endturn was required eigher by the player, by the ai or by [end_turn].
END_TURN_SYNCED	An [end_turn] was added to the replay.

Definition at line 89 of file playsingle_controller.hpp.

Constructor & Destructor Documentation

playsingle_controller::playsingle_controller	(	const config &	level,
		saved_game &	state_of_game,
		const config &	game_config,
		const tdata_cache &	tdata,
		CVideo &	video,
		bool	skip_replay
	)

Definition at line 72 of file playsingle_controller.cpp.

References play_controller::recieve_from_wesnothd().

playsingle_controller::~playsingle_controller ( )

virtual

Definition at line 113 of file playsingle_controller.cpp.

References ai::manager::clear_ais(), and ai::manager::remove_observer().

Member Function Documentation

void playsingle_controller::after_human_turn ( )

protectedvirtual

Reimplemented in playmp_controller.

Definition at line 513 of file playsingle_controller.cpp.

References play_controller::gui_.

Referenced by playmp_controller::after_human_turn(), and play_side_impl().

void playsingle_controller::before_human_turn ( )

protected

void playsingle_controller::check_objectives ( )

virtual

Implements play_controller.

Definition at line 611 of file playsingle_controller.cpp.

References game_state::board_, play_controller::gamestate(), play_controller::get_scenario_name(), play_controller::gui_, play_controller::is_browsing(), play_controller::is_regular_game_end(), team::objectives(), team::objectives_changed(), team::reset_objectives_changed(), dialogs::show_objectives(), and game_board::teams().

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

std::string playsingle_controller::describe_result ( ) const

Definition at line 100 of file playsingle_controller.cpp.

References play_controller::get_end_level_data_const(), and play_controller::is_regular_game_end().

void playsingle_controller::do_idle_notification ( )

protectedvirtual

Will handle sending a networked notification in descendent classes.

Reimplemented in playmp_controller.

Definition at line 573 of file playsingle_controller.cpp.

References play_controller::gui_, and events::chat_handler::MESSAGE_PUBLIC.

Referenced by play_side_impl().

void playsingle_controller::enable_replay ( bool is_unit_test = false )

Definition at line 670 of file playsingle_controller.cpp.

References play_controller::gamestate(), on_replay_end(), replay_, saved_game::replay_start(), and play_controller::saved_game_.

void playsingle_controller::end_turn ( )

Definition at line 598 of file playsingle_controller.cpp.

References play_controller::current_side(), events::menu_handler::end_turn(), end_turn_, END_TURN_REQUIRED, play_controller::is_browsing(), play_controller::linger_, and play_controller::menu_handler_.

Referenced by playmp_controller::play_linger_turn().

void playsingle_controller::end_turn_enable ( bool enable )

protected

Definition at line 506 of file playsingle_controller.cpp.

References play_controller::get_hotkey_command_executor(), play_controller::gui_, and hotkey::command_executor::set_button_state().

Referenced by playmp_controller::handle_generic_event(), linger(), play_ai_turn(), playmp_controller::play_human_turn(), play_human_turn(), playmp_controller::play_linger_turn(), playmp_controller::play_network_turn(), and play_side_impl().

void playsingle_controller::execute_gotos ( )

protected

Definition at line 433 of file playsingle_controller.cpp.

References play_controller::current_side(), events::menu_handler::execute_gotos(), play_controller::menu_handler_, play_controller::mouse_handler_, and should_return_to_play_side().

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

void playsingle_controller::force_end_turn ( )

virtual

Implements play_controller.

Definition at line 606 of file playsingle_controller.cpp.

References end_turn_, END_TURN_REQUIRED, and skip_next_turn_.

bool playsingle_controller::get_player_type_changed ( ) const

inline

Definition at line 60 of file playsingle_controller.hpp.

References play_controller::player_type_changed_.

replay_controller* playsingle_controller::get_replay_controller ( )

inline

Definition at line 63 of file playsingle_controller.hpp.

References replay_.

Referenced by playsingle_controller::hotkey_handler::get_replay_controller(), and is_replay().

void playsingle_controller::handle_generic_event ( const std::string & name )

virtual

Reimplemented from play_controller.

Reimplemented in playmp_controller.

Definition at line 590 of file playsingle_controller.cpp.

References controller_base::play_slice().

Referenced by playmp_controller::handle_generic_event().

void playsingle_controller::init_gui ( )

protectedvirtual

Reimplemented from play_controller.

Definition at line 119 of file playsingle_controller.cpp.

References play_controller::gamestate(), play_controller::get_hotkey_command_executor(), play_controller::gui_, play_controller::init_gui(), play_controller::is_skipping_replay(), LOG_NG, events::raise_draw_event(), hotkey::command_executor::set_button_state(), play_controller::ticks(), and display::WARP.

bool playsingle_controller::is_replay ( )

inlinevirtual

Reimplemented from play_controller.

Definition at line 64 of file playsingle_controller.hpp.

References get_replay_controller().

void playsingle_controller::linger ( )

protected

Definition at line 464 of file playsingle_controller.cpp.

References game_state::board_, end_turn_, end_turn_enable(), END_TURN_NONE, game::load_game_exception::game, play_controller::gamestate(), play_controller::gui_, game_display::LINGER, play_controller::linger_, LOG_NG, controller_base::play_slice(), game_display::RUNNING, play_controller::saved_game_, and game_board::set_all_units_user_end_turn().

Referenced by playsingle_controller::hotkey_handler::can_execute_command(), and maybe_linger().

void playsingle_controller::maybe_linger ( )

virtual

Reimplemented in playmp_controller.

Definition at line 622 of file playsingle_controller.cpp.

References play_controller::gamestate(), play_controller::get_end_level_data_const(), play_controller::is_regular_game_end(), and linger().

virtual void playsingle_controller::on_not_observer ( )

inlinevirtual

Implements play_controller.

Reimplemented in playmp_controller.

Definition at line 51 of file playsingle_controller.hpp.

void playsingle_controller::on_replay_end ( bool is_unit_test )

Definition at line 691 of file playsingle_controller.cpp.

References e, play_controller::is_regular_game_end(), end_level_data::is_victory, end_level_data::proceed_to_next_level, replay_, and play_controller::set_end_level_data().

Referenced by enable_replay().

void playsingle_controller::play_ai_turn ( )

protected

void playsingle_controller::play_human_turn ( )

protectedvirtual

Reimplemented in playmp_controller.

Definition at line 448 of file playsingle_controller.cpp.

References check_objectives(), preferences::disable_auto_moves(), end_turn_enable(), execute_gotos(), play_controller::gui_, play_controller::play_slice_catch(), should_return_to_play_side(), and show_turn_dialog().

Referenced by play_side_impl().

void playsingle_controller::play_idle_loop ( )

protectedvirtual

Reimplemented in playmp_controller.

Definition at line 344 of file playsingle_controller.cpp.

References play_controller::gui_, play_controller::play_slice_catch(), and should_return_to_play_side().

Referenced by play_side_impl().

void playsingle_controller::play_network_turn ( )

protectedvirtual

Will handle networked turns in descendent classes.

Reimplemented in playmp_controller.

Definition at line 583 of file playsingle_controller.cpp.

References ERR_NG.

Referenced by play_side_impl().

LEVEL_RESULT playsingle_controller::play_scenario ( const config & level )

Definition at line 213 of file playsingle_controller.cpp.

Referenced by campaign_controller::playmp_scenario().

void playsingle_controller::play_scenario_init ( )

Definition at line 135 of file playsingle_controller.cpp.

References _(), saved_game::classification(), config::empty(), play_controller::gui_, play_controller::is_networked_mp(), game_classification::random_mode, saved_game::replay_start(), play_controller::saved_game_, gui2::show_transient_message(), play_controller::start_game(), and play_controller::to_config().

Referenced by play_scenario(), and play_scenario_main_loop().

void playsingle_controller::play_scenario_main_loop ( )

void playsingle_controller::play_side_impl ( )

protectedvirtual

Reimplemented from play_controller.

Reimplemented in playmp_controller.

Definition at line 353 of file playsingle_controller.cpp.

References after_human_turn(), before_human_turn(), game_state::board_, team::controller(), play_controller::current_side(), play_controller::current_team(), do_idle_notification(), end_turn_, end_turn_enable(), END_TURN_NONE, END_TURN_REQUIRED, END_TURN_SYNCED, ERR_NG, play_controller::gamestate(), play_controller::is_regular_game_end(), LOG_NG, play_ai_turn(), play_human_turn(), play_idle_loop(), play_network_turn(), play_controller::player_type_changed_, team::proxy_controller(), replay_, REPLAY_FOUND_END_TURN, team::side(), unit_map::size(), skip_next_turn_, and game_board::units().

Referenced by playmp_controller::play_side_impl().

void playsingle_controller::reset_replay ( )

protected

Definition at line 659 of file playsingle_controller.cpp.

References ERR_NG, and replay_.

Referenced by playsingle_controller::hotkey_handler::reset_replay().

void playsingle_controller::set_player_type_changed ( )

inline

Definition at line 61 of file playsingle_controller.hpp.

References play_controller::player_type_changed_.

bool playsingle_controller::should_return_to_play_side ( )

virtual

Reimplemented from play_controller.

Definition at line 678 of file playsingle_controller.cpp.

References play_controller::current_team(), end_turn_, END_TURN_NONE, team::is_network(), play_controller::is_regular_game_end(), play_controller::player_type_changed_, and replay_.

Referenced by execute_gotos(), play_ai_turn(), playmp_controller::play_human_turn(), play_human_turn(), playmp_controller::play_idle_loop(), and play_idle_loop().

void playsingle_controller::show_turn_dialog ( )

protected

Definition at line 420 of file playsingle_controller.cpp.

References _(), game_state::board_, play_controller::current_side(), play_controller::gamestate(), play_controller::gui_, utils::interpolate_variables_into_string(), play_controller::is_regular_game_end(), gui2::show_transient_message(), game_board::teams(), and preferences::turn_dialog().

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

void playsingle_controller::store_gold ( bool obs = false )

protected

void playsingle_controller::store_recalls ( )

protected

void playsingle_controller::sync_end_turn ( )

protectedvirtual

Reimplemented from play_controller.

Definition at line 631 of file playsingle_controller.cpp.

References play_controller::current_team(), replay::end_turn(), end_turn_, END_TURN_REQUIRED, END_TURN_SYNCED, resources::recorder, skip_next_turn_, and synced_context::UNSYNCED.

void playsingle_controller::update_viewing_player ( )

protectedvirtual

Implements play_controller.

Definition at line 646 of file playsingle_controller.cpp.

References play_controller::find_last_visible_team(), play_controller::gui_, replay_, and play_controller::update_gui_to_player().

Member Data Documentation

const cursor::setter playsingle_controller::cursor_setter

protected

Definition at line 83 of file playsingle_controller.hpp.

Referenced by play_ai_turn().

END_TURN_STATE playsingle_controller::end_turn_

protected

Definition at line 98 of file playsingle_controller.hpp.

Referenced by before_human_turn(), end_turn(), force_end_turn(), playmp_controller::linger(), linger(), play_ai_turn(), playmp_controller::play_human_turn(), playmp_controller::play_linger_turn(), playmp_controller::play_network_turn(), play_side_impl(), playmp_controller::process_network_data(), should_return_to_play_side(), and sync_end_turn().

playturn_network_adapter playsingle_controller::network_reader_

protected

Definition at line 87 of file playsingle_controller.hpp.

Referenced by playmp_controller::play_linger_turn(), playmp_controller::process_network_data(), and playmp_controller::wait_for_upload().

boost::scoped_ptr<replay_controller> playsingle_controller::replay_

protected

Definition at line 100 of file playsingle_controller.hpp.

Referenced by enable_replay(), get_replay_controller(), on_replay_end(), play_scenario_main_loop(), play_side_impl(), reset_replay(), should_return_to_play_side(), and update_viewing_player().

replay_network_sender playsingle_controller::replay_sender_

protected

Definition at line 86 of file playsingle_controller.hpp.

bool playsingle_controller::skip_next_turn_

protected

Definition at line 99 of file playsingle_controller.hpp.

Referenced by force_end_turn(), play_side_impl(), and sync_end_turn().

gui::floating_textbox playsingle_controller::textbox_info_

protected

Definition at line 84 of file playsingle_controller.hpp.

turn_info playsingle_controller::turn_data_

protected

Definition at line 88 of file playsingle_controller.hpp.

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

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation