src/script/api/script_execmode.hpp

   1 /* $Id: script_execmode.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_execmode.hpp Switch the script to Execute Mode. */
  11
  12 #ifndef SCRIPT_EXECMODE_HPP
  13 #define SCRIPT_EXECMODE_HPP
  14
  15 #include "script_object.hpp"
  16
  17 /**
  18  * Class to switch current mode to Execute Mode.
  19  * If you create an instance of this class, the mode will be switched to
  20  *   Execute. The original mode is stored and recovered from when ever the
  21  *   instance is destroyed.
  22  * In Execute mode all commands you do are executed for real.
  23  * @api ai game
  24  */
  25 class ScriptExecMode : 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 Execute mode.
  33          */
  34         static bool ModeProc();
  35
  36 public:
  37         /**
  38          * Creating instance of this class switches the build mode to Execute.
  39          * @note When the instance is destroyed, he restores the mode that was
  40          *   current when the instance was created!
  41          */
  42         ScriptExecMode();
  43
  44         /**
  45          * Destroying this instance reset the building mode to the mode it was
  46          *   in when the instance was created.
  47          */
  48         ~ScriptExecMode();
  49
  50         /**
  51          * @api -all
  52          */
  53         virtual void FinalRelease();
  54 };
  55
  56 #endif /* SCRIPT_EXECMODE_HPP */