src/game/game_config.hpp

   1 /* $Id: game_config.hpp 23737 2012-01-03 20:37:56Z 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 game_config.hpp GameConfig stores the configuration settings of every Game. */
  11
  12 #ifndef GAME_CONFIG_HPP
  13 #define GAME_CONFIG_HPP
  14
  15 #include "../script/script_config.hpp"
  16
  17 class GameConfig : public ScriptConfig {
  18 public:
  19         /**
  20          * Get the config of a company.
  21          */
  22         static GameConfig *GetConfig(ScriptSettingSource source = SSS_DEFAULT);
  23
  24         GameConfig() :
  25                 ScriptConfig()
  26         {}
  27
  28         GameConfig(const GameConfig *config) :
  29                 ScriptConfig(config)
  30         {}
  31
  32         class GameInfo *GetInfo() const;
  33
  34         /**
  35          * When ever the Game Scanner is reloaded, all infos become invalid. This
  36          *  function tells GameConfig about this.
  37          * @param force_exact_match If true try to find the exact same version
  38          *   as specified. If false any version is ok.
  39          * @return \c true if the reset was successful, \c false if the Game was no longer
  40          *  found.
  41          */
  42         bool ResetInfo(bool force_exact_match);
  43
  44 protected:
  45         /* virtual */ ScriptInfo *FindInfo(const char *name, int version, bool force_exact_match);
  46 };
  47
  48 #endif /* GAME_CONFIG_HPP */