src/game/game_instance.hpp

   1 /* $Id$ */
   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 game_instance.hpp The GameInstance tracks games. */
  11
  12 #ifndef GAME_INSTANCE_HPP
  13 #define GAME_INSTANCE_HPP
  14
  15 #include "../script/script_instance.hpp"
  16
  17 /** Runtime information about a game script like a pointer to the squirrel vm and the current state. */
  18 class GameInstance : public ScriptInstance {
  19 public:
  20         GameInstance();
  21
  22         /**
  23          * Initialize the script and prepare it for its first run.
  24          * @param info The GameInfo to start.
  25          */
  26         void Initialize(class GameInfo *info);
  27
  28         /* virtual */ int GetSetting(const char *name);
  29         /* virtual */ ScriptInfo *FindLibrary(const char *library, int version);
  30
  31 private:
  32         /* virtual */ void RegisterAPI();
  33         /* virtual */ void Died();
  34         /* virtual */ CommandCallback *GetDoCommandCallback();
  35         /* virtual */ void LoadDummyScript() {}
  36 };
  37
  38 #endif /* GAME_INSTANCE_HPP */