The Battle for Wesnoth  1.19.0-dev
Public Member Functions | Public Attributes | List of all members
wml_exception Struct Referencefinal

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 Public Attributes inherited from lua_jailbreak_exception
static int jail_depth = 0
 Depth of recursive luaW_pcall_internal() function calls. More...
 
- Static Protected Attributes inherited from lua_jailbreak_exception
static lua_jailbreak_exceptionjailbreak_exception = nullptr
 The exception to be rethrown. More...
 

Detailed Description

Helper class, don't construct this directly.

Definition at line 99 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 102 of file wml_exception.hpp.

References lua_jailbreak_exception::store().

◆ ~wml_exception()

wml_exception::~wml_exception ( )
inlinenoexcept

Definition at line 109 of file wml_exception.hpp.

Member Function Documentation

◆ show()

void wml_exception::show ( ) const

Shows the error in a dialog.

Definition at line 60 of file wml_exception.cpp.

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

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 122 of file wml_exception.hpp.

Referenced by show().

◆ 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 115 of file wml_exception.hpp.

Referenced by show().


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