src/script/api/script_testmode.hpp

   1 /* $Id: script_testmode.hpp 24900 2013-01-08 22:46:42Z planetmaker $ */
   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_testmode.hpp Switch the script instance to Test Mode. */
  11
  12 #ifndef SCRIPT_TESTMODE_HPP
  13 #define SCRIPT_TESTMODE_HPP
  14
  15 #include "script_object.hpp"
  16
  17 /**
  18  * Class to switch current mode to Test Mode.
  19  * If you create an instance of this class, the mode will be switched to
  20  *   Testing. The original mode is stored and recovered from when ever the
  21  *   instance is destroyed.
  22  * In Test mode all the commands you execute aren't really executed. The
  23  *   system only checks if it would be able to execute your requests, and what
  24  *   the cost would be.
  25  * @api ai game
  26  */
  27 class ScriptTestMode : public ScriptObject {
  28 private:
  29         ScriptModeProc *last_mode;   ///< The previous mode we were in.
  30         ScriptObject *last_instance; ///< The previous instance of the mode.
  31
  32 protected:
  33         /**
  34          * The callback proc for Testing mode.
  35          */
  36         static bool ModeProc();
  37
  38 public:
  39         /**
  40          * Creating instance of this class switches the build mode to Testing.
  41          * @note When the instance is destroyed, he restores the mode that was
  42          *   current when the instance was created!
  43          */
  44         ScriptTestMode();
  45
  46         /**
  47          * Destroying this instance reset the building mode to the mode it was
  48          *   in when the instance was created.
  49          */
  50         ~ScriptTestMode();
  51
  52         /**
  53          * @api -all
  54          */
  55         virtual void FinalRelease();
  56 };
  57
  58 #endif /* SCRIPT_TESTMODE_HPP */