src/ai/ai_info.hpp

   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
   8 /** @file ai_info.hpp AIInfo keeps track of all information of an AI, like Author, Description, ... */
   9
  10 #ifndef AI_INFO_HPP
  11 #define AI_INFO_HPP
  12
  13 #include "../script/script_info.hpp"
  14
  15 /** All static information from an AI like name, version, etc. */
  16 class AIInfo : public ScriptInfo {
  17 public:
  18         AIInfo();
  19         ~AIInfo();
  20
  21         /**
  22          * Register the functions of this class.
  23          */
  24         static void RegisterAPI(Squirrel *engine);
  25
  26         /**
  27          * Create an AI, using this AIInfo as start-template.
  28          */
  29         static SQInteger Constructor(HSQUIRRELVM vm);
  30
  31         /**
  32          * Create a dummy-AI.
  33          */
  34         static SQInteger DummyConstructor(HSQUIRRELVM vm);
  35
  36         /**
  37          * Check if we can start this AI.
  38          */
  39         bool CanLoadFromVersion(int version) const;
  40
  41         /**
  42          * Use this AI as a random AI.
  43          */
  44         bool UseAsRandomAI() const { return this->use_as_random; }
  45
  46         /**
  47          * Get the API version this AI is written for.
  48          */
  49         const char *GetAPIVersion() const { return this->api_version; }
  50
  51 private:
  52         int min_loadable_version; ///< The AI can load savegame data if the version is equal or greater than this.
  53         bool use_as_random;       ///< Should this AI be used when the user wants a "random AI"?
  54         const char *api_version;  ///< API version used by this AI.
  55 };
  56
  57 /** All static information from an AI library like name, version, etc. */
  58 class AILibrary : public ScriptInfo {
  59 public:
  60         AILibrary() : ScriptInfo(), category(nullptr) {};
  61         ~AILibrary();
  62
  63         /**
  64          * Register the functions of this class.
  65          */
  66         static void RegisterAPI(Squirrel *engine);
  67
  68         /**
  69          * Create an AI, using this AIInfo as start-template.
  70          */
  71         static SQInteger Constructor(HSQUIRRELVM vm);
  72
  73         /**
  74          * Get the category this library is in.
  75          */
  76         const char *GetCategory() const { return this->category; }
  77
  78 private:
  79         const char *category; ///< The category this library is in.
  80 };
  81
  82 #endif /* AI_INFO_HPP */