src/subgame.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef SUBGAME_HEADER
  21 #define SUBGAME_HEADER
  22
  23 #include <string>
  24 #include <set>
  25 #include <vector>
  26
  27 struct SubgameSpec
  28 {
  29         std::string id; // "" = game does not exist
  30         std::string path;
  31         std::set<std::string> mods_paths;
  32         std::string name;
  33
  34         SubgameSpec(const std::string &id_="",
  35                         const std::string &path_="",
  36                         const std::set<std::string> &mods_paths_=std::set<std::string>(),
  37                         const std::string &name_=""):
  38                 id(id_),
  39                 path(path_),
  40                 mods_paths(mods_paths_),
  41                 name(name_)
  42         {}
  43
  44         bool isValid() const
  45         {
  46                 return (id != "" && path != "");
  47         }
  48 };
  49
  50 std::string getGameName(const std::string &game_path);
  51
  52 SubgameSpec findSubgame(const std::string &id);
  53 SubgameSpec findWorldSubgame(const std::string &world_path);
  54
  55 std::set<std::string> getAvailableGameIds();
  56 std::vector<SubgameSpec> getAvailableGames();
  57
  58 bool getWorldExists(const std::string &world_path);
  59 std::string getWorldGameId(const std::string &world_path,
  60                 bool can_be_legacy=false);
  61
  62 struct WorldSpec
  63 {
  64         std::string path;
  65         std::string name;
  66         std::string gameid;
  67
  68         WorldSpec(
  69                 const std::string &path_="",
  70                 const std::string &name_="",
  71                 const std::string &gameid_=""
  72         ):
  73                 path(path_),
  74                 name(name_),
  75                 gameid(gameid_)
  76         {}
  77
  78         bool isValid() const
  79         {
  80                 return (name != "" && path != "" && gameid != "");
  81         }
  82 };
  83
  84 std::vector<WorldSpec> getAvailableWorlds();
  85
  86 // Create world directory and world.mt if they don't exist
  87 bool initializeWorld(const std::string &path, const std::string &gameid);
  88
  89 #endif
  90