Inheritance diagram for events::console_handler:

Public Types
typedef map_command_handler< console_handler >	chmap

Public Types inherited from events::map_command_handler< console_handler >
typedef void(Worker::*	command_handler) ()

typedef std::map< std::string, command >	command_map

typedef std::map< std::string, std::string >	command_alias_map

Public Member Functions
	console_handler (menu_handler &menu_handler)

Public Member Functions inherited from events::map_command_handler< console_handler >
	map_command_handler ()

virtual	~map_command_handler ()

bool	empty () const

bool	dispatch (std::string cmd)

std::vector< std::string >	get_commands_list () const

void	command_failed (const std::string &message, bool=false)

Protected Member Functions
virtual void	register_command (const std::string &cmd, chat_command_handler::command_handler h, const std::string &help="", const std::string &usage="", const std::string &flags="")

virtual void	register_alias (const std::string &to_cmd, const std::string &cmd)

virtual std::string	get_arg (unsigned i) const

virtual std::string	get_cmd () const

virtual std::string	get_data (unsigned n=1) const

void	do_refresh ()

void	do_droid ()

void	do_terrain ()

void	do_idle ()

void	do_theme ()

void	do_control ()

void	do_controller ()

void	do_clear ()

void	do_foreground ()

void	do_layers ()

void	do_fps ()

void	do_benchmark ()

void	do_save ()

void	do_save_quit ()

void	do_quit ()

void	do_ignore_replay_errors ()

void	do_nosaves ()

void	do_next_level ()

void	do_choose_level ()

void	do_turn ()

void	do_turn_limit ()

void	do_debug ()

void	do_nodebug ()

void	do_lua ()

void	do_unsafe_lua ()

void	do_custom ()

void	do_set_alias ()

void	do_set_var ()

void	do_show_var ()

void	do_inspect ()

void	do_control_dialog ()

void	do_unit ()

void	do_discover ()

void	do_undiscover ()

void	do_create ()
	Implements the (debug mode) console command that creates a unit.

void	do_fog ()

void	do_shroud ()

void	do_gold ()

void	do_event ()

void	do_toggle_draw_coordinates ()

void	do_toggle_draw_terrain_codes ()

void	do_toggle_draw_num_of_bitmaps ()

void	do_toggle_whiteboard ()

void	do_whiteboard_options ()

std::string	get_flags_description () const

std::string	get_command_flags_description (const chmap::command &c) const

bool	is_enabled (const chmap::command &c) const

void	print (const std::string &title, const std::string &message)

void	init_map ()

std::string	get_command_flags_description (const map_command_handler< chat_command_handler >::command &c) const

Protected Member Functions inherited from events::map_command_handler< console_handler >
void	init_map_default ()

virtual std::string	get_command_flags_description (const command &) const

virtual bool	is_enabled (const command &) const

virtual void	parse_cmd (const std::string &cmd_string)

void	command_failed_need_arg (int argn)

void	print_usage ()

std::string	get_actual_cmd (const std::string &cmd) const

const command *	get_command (const std::string &cmd) const

command *	get_command (const std::string &cmd)

void	help ()

bool	help_command (const std::string &acmd)

Private Attributes
menu_handler &	menu_handler_

const unsigned int	team_num_

Private Attributes inherited from events::map_command_handler< chat_command_handler >
cmd_arg_parser	cap_

Additional Inherited Members
Static Protected Member Functions inherited from events::map_command_handler< console_handler >
static void	set_cmd_prefix (const std::string &value)

static void	set_cmd_flag (bool value)

static const std::vector< std::string >	get_aliases (const std::string &cmd)

Protected Attributes inherited from events::map_command_handler< console_handler >
cmd_arg_parser	cap_

Private Types inherited from events::chat_command_handler
typedef map_command_handler< chat_command_handler >	map

Private Types inherited from events::map_command_handler< chat_command_handler >
typedef void(Worker::*	command_handler) ()

typedef std::map< std::string, command >	command_map

typedef std::map< std::string, std::string >	command_alias_map

Private Member Functions inherited from events::chat_command_handler
	chat_command_handler (chat_handler &chathandler, bool allies_only)

void	do_emote ()

void	do_network_send ()

void	do_network_send (const std::string &data)

void	do_network_send_req_arg ()

void	do_whisper ()

void	do_log ()

void	do_ignore ()

void	do_friend ()

void	do_remove ()

void	do_display ()

void	do_version ()

void	do_clear_messages ()

void	do_mp_report ()

void	do_info ()
	Request information about a user from the server.

std::string	get_command_flags_description (const map_command_handler< chat_command_handler >::command &c) const

bool	is_enabled (const map_command_handler< chat_command_handler >::command &c) const

Private Member Functions inherited from events::map_command_handler< chat_command_handler >
	map_command_handler ()

virtual	~map_command_handler ()

bool	empty () const

bool	dispatch (std::string cmd)

std::vector< std::string >	get_commands_list () const

void	command_failed (const std::string &message, bool=false)

void	init_map_default ()

virtual std::string	get_command_flags_description (const command &) const

virtual bool	is_enabled (const command &) const

virtual void	parse_cmd (const std::string &cmd_string)

void	command_failed_need_arg (int argn)

void	print_usage ()

std::string	get_actual_cmd (const std::string &cmd) const

const command *	get_command (const std::string &cmd) const

command *	get_command (const std::string &cmd)

void	help ()

bool	help_command (const std::string &acmd)

Static Private Member Functions inherited from events::map_command_handler< chat_command_handler >
static void	set_cmd_prefix (const std::string &value)

static void	set_cmd_flag (bool value)

static const std::vector< std::string >	get_aliases (const std::string &cmd)

Detailed Description

Definition at line 1102 of file menu_events.cpp.

Member Typedef Documentation

◆ chmap

typedef map_command_handler<console_handler> events::console_handler::chmap

Definition at line 1106 of file menu_events.cpp.

Constructor & Destructor Documentation

◆ console_handler()

events::console_handler::console_handler ( menu_handler & menu_handler )

inline

Definition at line 1107 of file menu_events.cpp.

Member Function Documentation

◆ do_benchmark()

void events::console_handler::do_benchmark ( )

protected

Definition at line 1771 of file menu_events.cpp.

References display::DEBUG_BENCHMARK.

◆ do_choose_level()

void events::console_handler::do_choose_level ( )

protected

Definition at line 1807 of file menu_events.cpp.

References _(), id, and synced_context::run_and_throw().

◆ do_clear()

void events::console_handler::do_clear ( )

protected

Definition at line 1734 of file menu_events.cpp.

◆ do_control()

void events::console_handler::do_control ( )

protected

Definition at line 1660 of file menu_events.cpp.

References utils::ranges::find(), team::save_id(), and VGETTEXT.

◆ do_control_dialog()

void events::console_handler::do_control_dialog ( )

protected

Definition at line 1977 of file menu_events.cpp.

◆ do_controller()

void events::console_handler::do_controller ( )

protected

Definition at line 1702 of file menu_events.cpp.

References string_enums::enum_base< Definition >::get_string(), print(), and VGETTEXT.

◆ do_create()

void events::console_handler::do_create ( )

protected

Implements the (debug mode) console command that creates a unit.

Definition at line 2045 of file menu_events.cpp.

References _(), unit_type_data::find(), loc, and unit_types.

◆ do_custom()

void events::console_handler::do_custom ( )

protected

Definition at line 1917 of file menu_events.cpp.

References prefs::get().

◆ do_debug()

void events::console_handler::do_debug ( )

protected

Definition at line 1873 of file menu_events.cpp.

References _(), game_config::mp_debug, print(), and game_config::set_debug().

◆ do_discover()

void events::console_handler::do_discover ( )

protected

Definition at line 2028 of file menu_events.cpp.

References prefs::encountered_units(), prefs::get(), i, unit_type_data::types(), and unit_types.

◆ do_droid()

void events::console_handler::do_droid ( )

protected

Definition at line 1483 of file menu_events.cpp.

References _(), events::map_command_handler< Worker >::empty(), prefs::get(), team::is_ai(), team::is_droid(), team::is_human(), team::is_local(), team::is_network(), team::is_proxy_human(), prefs::login(), team::make_ai(), team::make_droid(), team::make_human(), team::make_proxy_human(), print(), and VGETTEXT.

◆ do_event()

void events::console_handler::do_event ( )

protected

Definition at line 2078 of file menu_events.cpp.

References synced_context::run_and_throw().

◆ do_fog()

void events::console_handler::do_fog ( )

protected

Definition at line 2063 of file menu_events.cpp.

References synced_context::run_and_throw().

◆ do_foreground()

void events::console_handler::do_foreground ( )

protected

Definition at line 1739 of file menu_events.cpp.

References display::DEBUG_FOREGROUND.

◆ do_fps()

void events::console_handler::do_fps ( )

protected

Definition at line 1766 of file menu_events.cpp.

References prefs::get(), and prefs::set_show_fps().

◆ do_gold()

void events::console_handler::do_gold ( )

protected

Definition at line 2073 of file menu_events.cpp.

References synced_context::run_and_throw().

◆ do_idle()

void events::console_handler::do_idle ( )

protected

Definition at line 1616 of file menu_events.cpp.

References events::map_command_handler< Worker >::empty(), team::is_idle(), team::is_local_ai(), team::is_local_human(), team::is_network(), team::toggle_idle(), and VGETTEXT.

◆ do_ignore_replay_errors()

void events::console_handler::do_ignore_replay_errors ( )

protected

Definition at line 1792 of file menu_events.cpp.

References game_config::ignore_replay_errors.

◆ do_inspect()

void events::console_handler::do_inspect ( )

protected

Definition at line 1970 of file menu_events.cpp.

References cfg, vconfig::empty_vconfig(), and resources::game_events.

◆ do_layers()

void events::console_handler::do_layers ( )

protected

Definition at line 1745 of file menu_events.cpp.

References loc.

◆ do_lua()

void events::console_handler::do_lua ( )

protected

Definition at line 1891 of file menu_events.cpp.

References synced_context::run_and_throw().

◆ do_next_level()

void events::console_handler::do_next_level ( )

protected

Definition at line 1802 of file menu_events.cpp.

References synced_context::run_and_throw().

◆ do_nodebug()

void events::console_handler::do_nodebug ( )

protected

Definition at line 1883 of file menu_events.cpp.

References _(), game_config::debug, print(), and game_config::set_debug().

◆ do_nosaves()

void events::console_handler::do_nosaves ( )

protected

Definition at line 1797 of file menu_events.cpp.

References game_config::disable_autosave.

◆ do_quit()

void events::console_handler::do_quit ( )

protected

Definition at line 1787 of file menu_events.cpp.

References throw_quit_game_exception().

◆ do_refresh()

void events::console_handler::do_refresh ( )

protected

Definition at line 1474 of file menu_events.cpp.

References image::flush_cache(), and sound::flush_cache().

◆ do_save()

void events::console_handler::do_save ( )

protected

Definition at line 1776 of file menu_events.cpp.

◆ do_save_quit()

void events::console_handler::do_save_quit ( )

protected

Definition at line 1781 of file menu_events.cpp.

◆ do_set_alias()

void events::console_handler::do_set_alias ( )

protected

Definition at line 1922 of file menu_events.cpp.

References prefs::add_alias(), data, prefs::get(), print(), and prefs::write_preferences().

◆ do_set_var()

void events::console_handler::do_set_var ( )

protected

Definition at line 1947 of file menu_events.cpp.

References _(), data, synced_context::run_and_throw(), and value.

◆ do_show_var()

void events::console_handler::do_show_var ( )

protected

Definition at line 1965 of file menu_events.cpp.

References gui2::show_transient_message().

◆ do_shroud()

void events::console_handler::do_shroud ( )

protected

Definition at line 2068 of file menu_events.cpp.

References synced_context::run_and_throw().

◆ do_terrain()

void events::console_handler::do_terrain ( )

protected

Definition at line 1597 of file menu_events.cpp.

References loc, synced_context::run_and_throw(), map_location::wml_x(), and map_location::wml_y().

◆ do_theme()

void events::console_handler::do_theme ( )

protected

Definition at line 1655 of file menu_events.cpp.

References prefs::get(), and prefs::show_theme_dialog().

◆ do_toggle_draw_coordinates()

void events::console_handler::do_toggle_draw_coordinates ( )

protected

Definition at line 2083 of file menu_events.cpp.

References display::DEBUG_COORDINATES.

◆ do_toggle_draw_num_of_bitmaps()

void events::console_handler::do_toggle_draw_num_of_bitmaps ( )

protected

Definition at line 2094 of file menu_events.cpp.

References display::DEBUG_NUM_BITMAPS.

◆ do_toggle_draw_terrain_codes()

void events::console_handler::do_toggle_draw_terrain_codes ( )

protected

Definition at line 2088 of file menu_events.cpp.

References display::DEBUG_TERRAIN_CODES.

◆ do_toggle_whiteboard()

void events::console_handler::do_toggle_whiteboard ( )

protected

Definition at line 2100 of file menu_events.cpp.

References _(), and print().

◆ do_turn()

void events::console_handler::do_turn ( )

protected

Definition at line 1855 of file menu_events.cpp.

References data, synced_context::run_and_throw(), and tod_manager::turn().

◆ do_turn_limit()

void events::console_handler::do_turn_limit ( )

protected

Definition at line 1867 of file menu_events.cpp.

References synced_context::run_and_throw().

◆ do_undiscover()

void events::console_handler::do_undiscover ( )

protected

Definition at line 2035 of file menu_events.cpp.

References _(), gui2::CANCEL, prefs::encountered_units(), prefs::get(), gui2::show_message(), and gui2::dialogs::message::yes_no_buttons.

◆ do_unit()

void events::console_handler::do_unit ( )

protected

Definition at line 1982 of file menu_events.cpp.

References events::commands_disabled, data, string_enums::enum_base< Definition >::get_enum(), i, loc, synced_context::run_and_throw(), utils::split(), utils::STRIP_SPACES, VGETTEXT, map_location::wml_x(), and map_location::wml_y().

◆ do_unsafe_lua()

void events::console_handler::do_unsafe_lua ( )

protected

Definition at line 1900 of file menu_events.cpp.

References _(), gui2::OK, gui2::dialogs::message::ok_cancel_buttons, print(), and gui2::show_message().

◆ do_whiteboard_options()

void events::console_handler::do_whiteboard_options ( )

protected

Definition at line 2113 of file menu_events.cpp.

◆ get_arg()

virtual std::string events::console_handler::get_arg ( unsigned i ) const

inlineprotectedvirtual

Reimplemented from events::map_command_handler< console_handler >.

Definition at line 1136 of file menu_events.cpp.

References i.

◆ get_cmd()

virtual std::string events::console_handler::get_cmd ( ) const

inlineprotectedvirtual

Reimplemented from events::map_command_handler< console_handler >.

Definition at line 1141 of file menu_events.cpp.

◆ get_command_flags_description() [1/2]

std::string events::console_handler::get_command_flags_description ( const chmap::command & c ) const

inlineprotected

Definition at line 1211 of file menu_events.cpp.

References _(), and c.

◆ get_command_flags_description() [2/2]

std::string events::chat_command_handler::get_command_flags_description ( const map_command_handler< chat_command_handler >::command & c ) const

inlineprotected

Definition at line 54 of file chat_command_handler.hpp.

◆ get_data()

virtual std::string events::console_handler::get_data ( unsigned n = 1 ) const

inlineprotectedvirtual

Reimplemented from events::map_command_handler< console_handler >.

Definition at line 1146 of file menu_events.cpp.

References n.

◆ get_flags_description()

std::string events::console_handler::get_flags_description ( ) const

inlineprotectedvirtual

Reimplemented from events::map_command_handler< console_handler >.

Definition at line 1205 of file menu_events.cpp.

References _().

◆ init_map()

void events::console_handler::init_map ( )

inlineprotectedvirtual

Implements events::map_command_handler< console_handler >.

Definition at line 1234 of file menu_events.cpp.

References _(), prefs::get(), and value.

◆ is_enabled()

bool events::console_handler::is_enabled ( const chmap::command & c ) const

inlineprotected

Definition at line 1221 of file menu_events.cpp.

References c, game_config::debug, synced_context::get_synced_state(), mp::logged_in_as_moderator(), and synced_context::UNSYNCED.

◆ print()

void events::console_handler::print	(	const std::string &	title,
		const std::string &	message
	)

inlineprotectedvirtual

Implements events::map_command_handler< console_handler >.

Definition at line 1229 of file menu_events.cpp.

◆ register_alias()

virtual void events::console_handler::register_alias	(	const std::string &	to_cmd,
		const std::string &	cmd
	)

inlineprotectedvirtual

Reimplemented from events::map_command_handler< console_handler >.

Definition at line 1131 of file menu_events.cpp.

◆ register_command()

virtual void events::console_handler::register_command	(	const std::string &	cmd,
		chat_command_handler::command_handler	h,
		const std::string &	help = `""`,
		const std::string &	usage = `""`,
		const std::string &	flags = `""`
	)

inlineprotectedvirtual

Reimplemented from events::map_command_handler< console_handler >.

Definition at line 1122 of file menu_events.cpp.

References h.

Member Data Documentation

◆ menu_handler_

menu_handler& events::console_handler::menu_handler_

private

Definition at line 1348 of file menu_events.cpp.

◆ team_num_

const unsigned int events::console_handler::team_num_

private

Definition at line 1349 of file menu_events.cpp.

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

menu_events.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ chmap

Constructor & Destructor Documentation

◆ console_handler()

Member Function Documentation

◆ do_benchmark()

◆ do_choose_level()

◆ do_clear()

◆ do_control()

◆ do_control_dialog()

◆ do_controller()

◆ do_create()

◆ do_custom()

◆ do_debug()

◆ do_discover()

◆ do_droid()

◆ do_event()

◆ do_fog()

◆ do_foreground()

◆ do_fps()

◆ do_gold()

◆ do_idle()

◆ do_ignore_replay_errors()

◆ do_inspect()

◆ do_layers()

◆ do_lua()

◆ do_next_level()

◆ do_nodebug()

◆ do_nosaves()

◆ do_quit()

◆ do_refresh()

◆ do_save()

◆ do_save_quit()

◆ do_set_alias()

◆ do_set_var()

◆ do_show_var()

◆ do_shroud()

◆ do_terrain()

◆ do_theme()

◆ do_toggle_draw_coordinates()

◆ do_toggle_draw_num_of_bitmaps()

◆ do_toggle_draw_terrain_codes()

◆ do_toggle_whiteboard()

◆ do_turn()

◆ do_turn_limit()

◆ do_undiscover()

◆ do_unit()

◆ do_unsafe_lua()

◆ do_whiteboard_options()

◆ get_arg()

◆ get_cmd()

◆ get_command_flags_description() [1/2]

◆ get_command_flags_description() [2/2]

◆ get_data()

◆ get_flags_description()

◆ init_map()

◆ is_enabled()

◆ print()

◆ register_alias()

◆ register_command()

Member Data Documentation

◆ menu_handler_

◆ team_num_