src/script/script_fatalerror.hpp

   1 /* $Id: script_fatalerror.hpp 23378 2011-11-30 14:02:15Z truebrain $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file script_fatalerror.hpp The definition of Script_FatalError. */
  11
  12 #ifndef SCRIPT_FATALERROR_HPP
  13 #define SCRIPT_FATALERROR_HPP
  14
  15 /**
  16  * A throw-class that is given when the script made a fatal error.
  17  */
  18 class Script_FatalError {
  19 public:
  20         /**
  21          * Creates a "fatal error" exception.
  22          * @param msg The message describing the cause of the fatal error.
  23          */
  24         Script_FatalError(const char *msg) :
  25                 msg(msg)
  26         {}
  27
  28         /**
  29          * The error message associated with the fatal error.
  30          * @return The error message.
  31          */
  32         const char *GetErrorMessage() { return msg; }
  33
  34 private:
  35         const char *msg; ///< The error message.
  36 };
  37
  38 #endif /* SCRIPT_FATALERROR_HPP */