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