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