/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

/** @file game_config.hpp GameConfig stores the configuration settings of every Game. */

#ifndef GAME_CONFIG_HPP
#define GAME_CONFIG_HPP

#include "../script/script_config.hpp"

/** Game script instantion of script configuration. */
class GameConfig : public ScriptConfig {
public:
	/**
	 * Get the script configuration.
	 * @param source The context, i.e. current / new game mode.
	 * @return The configuration.
	 */
	static GameConfig *GetConfig(ScriptSettingSource source = ScriptSettingSource::Default);

	GameConfig() :
		ScriptConfig()
	{}

	/**
	 * Copy constructor.
	 * @param config The configuration to copy.
	 */
	GameConfig(const GameConfig &config) :
		ScriptConfig(config)
	{}

	/** @copydoc ScriptConfig::GetInfo. */
	class GameInfo *GetInfo() const;

	/**
	 * When ever the Game Scanner is reloaded, all infos become invalid. This
	 *  function tells GameConfig about this.
	 * @param force_exact_match If true try to find the exact same version
	 *   as specified. If false any version is ok.
	 * @return \c true if the reset was successful, \c false if the Game was no longer
	 *  found.
	 */
	bool ResetInfo(bool force_exact_match);

protected:
	ScriptInfo *FindInfo(const std::string &name, int version, bool force_exact_match) override;
};

#endif /* GAME_CONFIG_HPP */
