Helper class, don't construct this directly. More...

#include <wml_exception.hpp>

Inheritance diagram for wml_exception:

Public Member Functions
	wml_exception (const std::string &user_msg, const std::string &dev_msg)

	~wml_exception () noexcept

void	show () const
	Shows the error in a dialog. More...

Public Member Functions inherited from lua_jailbreak_exception
virtual	~lua_jailbreak_exception () noexcept

void	store () const noexcept
	Stores a copy the current exception to be rethrown. More...

Public Attributes
std::string	user_message
	The message for the user explaining what went wrong. More...

std::string	dev_message
	The message for developers telling which problem was triggered, this shouldn't be translated. More...

Additional Inherited Members
Static Public Member Functions inherited from lua_jailbreak_exception
static void	rethrow ()
	Rethrows the stored exception. More...

Static Protected Attributes inherited from lua_jailbreak_exception
static lua_jailbreak_exception *	jailbreak_exception = nullptr
	The exception to be rethrown. More...

Detailed Description

Helper class, don't construct this directly.

Definition at line 93 of file wml_exception.hpp.

Constructor & Destructor Documentation

◆ wml_exception()

wml_exception::wml_exception	(	const std::string &	user_msg,
		const std::string &	dev_msg
	)

inline

Definition at line 96 of file wml_exception.hpp.

◆ ~wml_exception()

wml_exception::~wml_exception ( )

inlinenoexcept

Definition at line 102 of file wml_exception.hpp.

Member Function Documentation

◆ show()

void wml_exception::show ( ) const

Shows the error in a dialog.

Definition at line 56 of file wml_exception.cpp.

References _(), dev_message, gui2::show_error_message(), and user_message.

Referenced by ad_hoc_addon_fetch_session(), editor::editor_controller::do_screenshot(), game_launcher::launch_game(), game_launcher::load_game(), editor::editor_controller::main_loop(), campaign_controller::play_game(), game_launcher::play_multiplayer(), game_launcher::play_replay(), sp::select_campaign(), and game_events::WML_HANDLER_FUNCTION().

Member Data Documentation

◆ dev_message

std::string wml_exception::dev_message

The message for developers telling which problem was triggered, this shouldn't be translated.

It's hard for a dev to parse errors in foreign tongues.

Definition at line 115 of file wml_exception.hpp.

Referenced by mp::game_info::game_info(), main(), ng::scenario::set_metadata(), show(), game_launcher::single_unit_test(), and gui2::dialogs::unit_test_window().

◆ user_message

std::string wml_exception::user_message

The message for the user explaining what went wrong.

This message can be translated so the user gets a explanation in his/her native tongue.

Definition at line 108 of file wml_exception.hpp.

Referenced by BOOST_AUTO_TEST_CASE(), editor::editor_map::from_string(), main(), and show().

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

Public Member Functions

Public Attributes

Additional Inherited Members