OpenTTD Source: src/game/game_info.hpp Source File

OpenTTD Source 14.0-beta1

game_info.hpp
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 <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef GAME_INFO_HPP
11 #define GAME_INFO_HPP
12
13 #include "../script/script_info.hpp"
14
16 class GameInfo : public ScriptInfo {
17 public:
18 GameInfo();
19
23 static void RegisterAPI(Squirrel *engine);
24
28 static SQInteger Constructor(HSQUIRRELVM vm);
29
33 bool CanLoadFromVersion(int version) const;
34
38 const std::string &GetAPIVersion() const { return this->api_version; }
39
40 bool IsDeveloperOnly() const override { return this->is_developer_only; }
41
42 private:
43 int min_loadable_version;
44 bool is_developer_only;
45 std::string api_version;
46 };
47
49 class GameLibrary : public ScriptInfo {
50 public:
51 GameLibrary() : ScriptInfo() {};
52
56 static void RegisterAPI(Squirrel *engine);
57
61 static SQInteger Constructor(HSQUIRRELVM vm);
62
66 const std::string &GetCategory() const { return this->category; }
67
68 private:
69 std::string category;
70 };
71
72 #endif /* GAME_INFO_HPP */
GameInfo::GetAPIVersion
const std::string & GetAPIVersion() const
Get the API version this Game is written for.
Definition: game_info.hpp:38
GameInfo::api_version
std::string api_version
API version used by this Game.
Definition: game_info.hpp:45
ScriptInfo::engine
class Squirrel * engine
Engine used to register for Squirrel.
Definition: script_info.hpp:139
GameLibrary::category
std::string category
The category this library is in.
Definition: game_info.hpp:69
GameLibrary::GetCategory
const std::string & GetCategory() const
Get the category this library is in.
Definition: game_info.hpp:66
GameLibrary::Constructor
static SQInteger Constructor(HSQUIRRELVM vm)
Create an GSLibrary, using this GSInfo as start-template.
Definition: game_info.cpp:109
ScriptInfo::version
int version
Version of the script.
Definition: script_info.hpp:152
Squirrel
Definition: squirrel.hpp:23
GameInfo::CanLoadFromVersion
bool CanLoadFromVersion(int version) const
Check if we can start this Game.
Definition: game_info.cpp:94
GameInfo::Constructor
static SQInteger Constructor(HSQUIRRELVM vm)
Create an Game, using this GameInfo as start-template.
Definition: game_info.cpp:52
GameLibrary::RegisterAPI
static void RegisterAPI(Squirrel *engine)
Register the functions of this class.
Definition: game_info.cpp:101
GameInfo::RegisterAPI
static void RegisterAPI(Squirrel *engine)
Register the functions of this class.
Definition: game_info.cpp:34
GameInfo::is_developer_only
bool is_developer_only
Is the script selectable by non-developers?
Definition: game_info.hpp:44
GameInfo
All static information from an Game like name, version, etc.
Definition: game_info.hpp:16
GameLibrary
All static information from an Game library like name, version, etc.
Definition: game_info.hpp:49
GameInfo::min_loadable_version
int min_loadable_version
The Game can load savegame data if the version is equal or greater than this.
Definition: game_info.hpp:43
ScriptInfo
All static information from an Script like name, version, etc.
Definition: script_info.hpp:30
GameInfo::IsDeveloperOnly
bool IsDeveloperOnly() const override
Can this script be selected by developers only?
Definition: game_info.hpp:40