src/script/api/script_testmode.hpp

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