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

OpenTTD Source 15.0-RC2

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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
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 {
17public:
18 /* All valid GameScript API versions, in order. */
19 static constexpr std::string_view ApiVersions[]{ "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8", "1.9", "1.10", "1.11", "12", "13", "14", "15" };
20
21 GameInfo();
22
26 static void RegisterAPI(Squirrel &engine);
27
31 static SQInteger Constructor(HSQUIRRELVM vm);
32
36 bool CanLoadFromVersion(int version) const;
37
41 const std::string &GetAPIVersion() const { return this->api_version; }
42
43 bool IsDeveloperOnly() const override { return this->is_developer_only; }
44
45private:
46 int min_loadable_version;
47 bool is_developer_only;
48 std::string api_version;
49};
50
52 class GameLibrary : public ScriptInfo {
53public:
54 GameLibrary() : ScriptInfo() {};
55
59 static void RegisterAPI(Squirrel &engine);
60
64 static SQInteger Constructor(HSQUIRRELVM vm);
65
69 const std::string &GetCategory() const { return this->category; }
70
71private:
72 std::string category;
73};
74
75#endif /* GAME_INFO_HPP */
GameInfo
All static information from an Game like name, version, etc.
Definition game_info.hpp:16
GameInfo::IsDeveloperOnly
bool IsDeveloperOnly() const override
Can this script be selected by developers only?
Definition game_info.hpp:43
GameInfo::api_version
std::string api_version
API version used by this Game.
Definition game_info.hpp:48
GameInfo::Constructor
static SQInteger Constructor(HSQUIRRELVM vm)
Create an Game, using this GameInfo as start-template.
Definition game_info.cpp:48
GameInfo::CanLoadFromVersion
bool CanLoadFromVersion(int version) const
Check if we can start this Game.
Definition game_info.cpp:91
GameInfo::RegisterAPI
static void RegisterAPI(Squirrel &engine)
Register the functions of this class.
Definition game_info.cpp:30
GameInfo::is_developer_only
bool is_developer_only
Is the script selectable by non-developers?
Definition game_info.hpp:47
GameInfo::GetAPIVersion
const std::string & GetAPIVersion() const
Get the API version this Game is written for.
Definition game_info.hpp:41
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:46
GameLibrary
All static information from an Game library like name, version, etc.
Definition game_info.hpp:52
GameLibrary::RegisterAPI
static void RegisterAPI(Squirrel &engine)
Register the functions of this class.
Definition game_info.cpp:98
GameLibrary::GetCategory
const std::string & GetCategory() const
Get the category this library is in.
Definition game_info.hpp:69
GameLibrary::category
std::string category
The category this library is in.
Definition game_info.hpp:72
GameLibrary::Constructor
static SQInteger Constructor(HSQUIRRELVM vm)
Create an GSLibrary, using this GSInfo as start-template.
Definition game_info.cpp:106
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::engine
class Squirrel * engine
Engine used to register for Squirrel.
Definition script_info.hpp:133
Squirrel
Definition squirrel.hpp:24