OpenTTD Source: src/game/game_config.cpp Source File

OpenTTD Source 15.0-RC2

game_config.cpp
Go to the documentation of this file.
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "../stdafx.h"
11#include "../settings_type.h"
12#include "game.hpp"
13#include "game_config.hpp"
14#include "game_info.hpp"
15
16#include "../safeguards.h"
17
18/* static */ GameConfig *GameConfig::GetConfig(ScriptSettingSource source)
19{
20 if (_game_mode == GM_MENU) source = SSS_FORCE_NEWGAME;
21
22 auto &config = (source == SSS_FORCE_NEWGAME) ? _settings_newgame.script_config.game : _settings_game.script_config.game;
23 if (config == nullptr) config = std::make_unique<GameConfig>();
24
25 return config.get();
26}
27
28class GameInfo *GameConfig::GetInfo() const
29{
30 return static_cast<class GameInfo *>(ScriptConfig::GetInfo());
31}
32
33 ScriptInfo *GameConfig::FindInfo(const std::string &name, int version, bool force_exact_match)
34{
35 return static_cast<ScriptInfo *>(Game::FindInfo(name, version, force_exact_match));
36}
37
38 bool GameConfig::ResetInfo(bool force_exact_match)
39{
40 this->info = (ScriptInfo *)Game::FindInfo(this->name, force_exact_match ? this->version : -1, force_exact_match);
41 return this->info != nullptr;
42}
GameConfig
Definition game_config.hpp:15
GameConfig::FindInfo
ScriptInfo * FindInfo(const std::string &name, int version, bool force_exact_match) override
This function should call back to the Scanner in charge of this Config, to find the ScriptInfo belong...
Definition game_config.cpp:33
GameConfig::ResetInfo
bool ResetInfo(bool force_exact_match)
When ever the Game Scanner is reloaded, all infos become invalid.
Definition game_config.cpp:38
GameConfig::GetConfig
static GameConfig * GetConfig(ScriptSettingSource source=SSS_DEFAULT)
Get the config of a company.
Definition game_config.cpp:18
GameInfo
All static information from an Game like name, version, etc.
Definition game_info.hpp:16
Game::FindInfo
static class GameInfo * FindInfo(const std::string &name, int version, bool force_exact_match)
Wrapper function for GameScannerInfo::FindInfo.
Definition game_core.cpp:223
ScriptConfig::ScriptSettingSource
ScriptSettingSource
Where to get the config from, either default (depends on current game mode) or force either newgame o...
Definition script_config.hpp:97
ScriptConfig::SSS_FORCE_NEWGAME
@ SSS_FORCE_NEWGAME
Get the newgame Script config.
Definition script_config.hpp:99
ScriptConfig::version
int version
Version of the Script.
Definition script_config.hpp:178
ScriptConfig::info
class ScriptInfo * info
ScriptInfo object for related to this Script version.
Definition script_config.hpp:179
ScriptConfig::GetInfo
class ScriptInfo * GetInfo() const
Get the ScriptInfo linked to this ScriptConfig.
Definition script_config.cpp:55
ScriptConfig::name
std::string name
Name of the Script.
Definition script_config.hpp:177
ScriptInfo
All static information from an Script like name, version, etc.
Definition script_info.hpp:30
ScriptInfo::version
int version
Version of the script.
Definition script_info.hpp:146
ScriptInfo::name
std::string name
Full name of the script.
Definition script_info.hpp:141
game.hpp
Base functions for all Games.
game_config.hpp
GameConfig stores the configuration settings of every Game.
game_info.hpp
GameInfo keeps track of all information of an Game, like Author, Description, ...
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
_settings_newgame
GameSettings _settings_newgame
Game settings for new games (updated from the intro screen).
Definition settings.cpp:62
GameSettings::script_config
ScriptConfigSettings script_config
AI and Gamescript configuration.
Definition settings_type.h:638
ScriptConfigSettings::game
std::unique_ptr< class GameConfig > game
settings for gamescript
Definition settings_type.h:622