mirror of https://github.com/OpenTTD/OpenTTD.git
37 lines
1.2 KiB
C++
37 lines
1.2 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
|
|
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/** @file script_fatalerror.hpp The definition of Script_FatalError. */
|
|
|
|
#ifndef SCRIPT_FATALERROR_HPP
|
|
#define SCRIPT_FATALERROR_HPP
|
|
|
|
/**
|
|
* A throw-class that is given when the script made a fatal error.
|
|
*/
|
|
class Script_FatalError {
|
|
public:
|
|
/**
|
|
* Creates a "fatal error" exception.
|
|
* @param msg The message describing the cause of the fatal error.
|
|
*/
|
|
Script_FatalError(const std::string &msg) :
|
|
msg(msg)
|
|
{}
|
|
|
|
/**
|
|
* The error message associated with the fatal error.
|
|
* @return The error message.
|
|
*/
|
|
const std::string &GetErrorMessage() const { return msg; }
|
|
|
|
private:
|
|
const std::string msg; ///< The error message.
|
|
};
|
|
|
|
#endif /* SCRIPT_FATALERROR_HPP */
|