game_info.hpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef GAME_INFO_HPP
#define GAME_INFO_HPP
 
#include "../script/script_info.hpp"
 
class GameInfo : public ScriptInfo {
public:
  /* All valid GameScript API versions, in order. */
  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" };
 
  GameInfo();
 
  static void RegisterAPI(Squirrel *engine);
 
  static SQInteger Constructor(HSQUIRRELVM vm);
 
  bool CanLoadFromVersion(int version) const;
 
  const std::string &GetAPIVersion() const { return this->api_version; }
 
  bool IsDeveloperOnly() const override { return this->is_developer_only; }
 
private:
  int min_loadable_version; 
  bool is_developer_only;   
  std::string api_version;  
};
 
class GameLibrary : public ScriptInfo {
public:
  GameLibrary() : ScriptInfo() {};
 
  static void RegisterAPI(Squirrel *engine);
 
  static SQInteger Constructor(HSQUIRRELVM vm);
 
  const std::string &GetCategory() const { return this->category; }
 
private:
  std::string category; 
};
 
#endif /* GAME_INFO_HPP */