OpenTTD Source  12.0-beta2
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  ~GameInfo();
20 
24  static void RegisterAPI(Squirrel *engine);
25 
29  static SQInteger Constructor(HSQUIRRELVM vm);
30 
34  bool CanLoadFromVersion(int version) const;
35 
39  const char *GetAPIVersion() const { return this->api_version; }
40 
41  bool IsDeveloperOnly() const override { return this->is_developer_only; }
42 
43 private:
46  const char *api_version;
47 };
48 
50 class GameLibrary : public ScriptInfo {
51 public:
52  GameLibrary() : ScriptInfo(), category(nullptr) {};
53  ~GameLibrary();
54 
58  static void RegisterAPI(Squirrel *engine);
59 
63  static SQInteger Constructor(HSQUIRRELVM vm);
64 
68  const char *GetCategory() const { return this->category; }
69 
70 private:
71  const char *category;
72 };
73 
74 #endif /* GAME_INFO_HPP */
ScriptInfo::engine
class Squirrel * engine
Engine used to register for Squirrel.
Definition: script_info.hpp:148
GameInfo::GetAPIVersion
const char * GetAPIVersion() const
Get the API version this Game is written for.
Definition: game_info.hpp:39
GameLibrary::Constructor
static SQInteger Constructor(HSQUIRRELVM vm)
Create an GSLibrary, using this GSInfo as start-template.
Definition: game_info.cpp:121
ScriptInfo::version
int version
Version of the script.
Definition: script_info.hpp:161
Squirrel
Definition: squirrel.hpp:23
GameInfo::CanLoadFromVersion
bool CanLoadFromVersion(int version) const
Check if we can start this Game.
Definition: game_info.cpp:101
GameInfo::Constructor
static SQInteger Constructor(HSQUIRRELVM vm)
Create an Game, using this GameInfo as start-template.
Definition: game_info.cpp:53
GameLibrary::RegisterAPI
static void RegisterAPI(Squirrel *engine)
Register the functions of this class.
Definition: game_info.cpp:113
GameLibrary::category
const char * category
The category this library is in.
Definition: game_info.hpp:71
GameLibrary::GetCategory
const char * GetCategory() const
Get the category this library is in.
Definition: game_info.hpp:68
GameInfo::RegisterAPI
static void RegisterAPI(Squirrel *engine)
Register the functions of this class.
Definition: game_info.cpp:35
GameInfo::is_developer_only
bool is_developer_only
Is the script selectable by non-developers?
Definition: game_info.hpp:45
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:50
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:44
ScriptInfo
All static information from an Script like name, version, etc.
Definition: script_info.hpp:30
GameInfo::api_version
const char * api_version
API version used by this Game.
Definition: game_info.hpp:46
GameInfo::IsDeveloperOnly
bool IsDeveloperOnly() const override
Can this script be selected by developers only?
Definition: game_info.hpp:41