OpenTTD Source: src/ai/ai_info.hpp Source File

OpenTTD Source 15.0-RC2

ai_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 AI_INFO_HPP
11#define AI_INFO_HPP
12
13#include "../script/script_info.hpp"
14
16 class AIInfo : public ScriptInfo {
17public:
18 /* All valid AI API versions, in order. */
19 static constexpr std::string_view ApiVersions[]{ "0.7", "1.0", "1.1", "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 AIInfo();
22
26 static void RegisterAPI(Squirrel &engine);
27
31 static SQInteger Constructor(HSQUIRRELVM vm);
32
36 static SQInteger DummyConstructor(HSQUIRRELVM vm);
37
41 bool CanLoadFromVersion(int version) const;
42
46 bool UseAsRandomAI() const { return this->use_as_random; }
47
51 const std::string &GetAPIVersion() const { return this->api_version; }
52
53private:
54 int min_loadable_version;
55 bool use_as_random;
56 std::string api_version;
57};
58
60 class AILibrary : public ScriptInfo {
61public:
62 AILibrary() : ScriptInfo() {};
63
67 static void RegisterAPI(Squirrel &engine);
68
72 static SQInteger Constructor(HSQUIRRELVM vm);
73
77 const std::string &GetCategory() const { return this->category; }
78
79private:
80 std::string category;
81};
82
83#endif /* AI_INFO_HPP */
AIInfo
All static information from an AI like name, version, etc.
Definition ai_info.hpp:16
AIInfo::CanLoadFromVersion
bool CanLoadFromVersion(int version) const
Check if we can start this AI.
Definition ai_info.cpp:121
AIInfo::UseAsRandomAI
bool UseAsRandomAI() const
Use this AI as a random AI.
Definition ai_info.hpp:46
AIInfo::GetAPIVersion
const std::string & GetAPIVersion() const
Get the API version this AI is written for.
Definition ai_info.hpp:51
AIInfo::use_as_random
bool use_as_random
Should this AI be used when the user wants a "random AI"?
Definition ai_info.hpp:55
AIInfo::min_loadable_version
int min_loadable_version
The AI can load savegame data if the version is equal or greater than this.
Definition ai_info.hpp:54
AIInfo::api_version
std::string api_version
API version used by this AI.
Definition ai_info.hpp:56
AIInfo::RegisterAPI
static void RegisterAPI(Squirrel &engine)
Register the functions of this class.
Definition ai_info.cpp:32
AIInfo::Constructor
static SQInteger Constructor(HSQUIRRELVM vm)
Create an AI, using this AIInfo as start-template.
Definition ai_info.cpp:57
AIInfo::DummyConstructor
static SQInteger DummyConstructor(HSQUIRRELVM vm)
Create a dummy-AI.
Definition ai_info.cpp:97
AILibrary
All static information from an AI library like name, version, etc.
Definition ai_info.hpp:60
AILibrary::GetCategory
const std::string & GetCategory() const
Get the category this library is in.
Definition ai_info.hpp:77
AILibrary::category
std::string category
The category this library is in.
Definition ai_info.hpp:80
AILibrary::RegisterAPI
static void RegisterAPI(Squirrel &engine)
Register the functions of this class.
Definition ai_info.cpp:128
AILibrary::Constructor
static SQInteger Constructor(HSQUIRRELVM vm)
Create an AI, using this AIInfo as start-template.
Definition ai_info.cpp:136
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