src/mg_schematic.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser 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 MG_SCHEMATIC_HEADER
  21 #define MG_SCHEMATIC_HEADER
  22
  23 #include <map>
  24 #include "mg_decoration.h"
  25 #include "util/string.h"
  26
  27 class Map;
  28 class Mapgen;
  29 class MMVManip;
  30 class PseudoRandom;
  31 class NodeResolver;
  32 class IGameDef;
  33
  34 /*
  35         Minetest Schematic File Format
  36
  37         All values are stored in big-endian byte order.
  38         [u32] signature: 'MTSM'
  39         [u16] version: 3
  40         [u16] size X
  41         [u16] size Y
  42         [u16] size Z
  43         For each Y:
  44                 [u8] slice probability value
  45         [Name-ID table] Name ID Mapping Table
  46                 [u16] name-id count
  47                 For each name-id mapping:
  48                         [u16] name length
  49                         [u8[]] name
  50         ZLib deflated {
  51         For each node in schematic:  (for z, y, x)
  52                 [u16] content
  53         For each node in schematic:
  54                 [u8] probability of occurance (param1)
  55         For each node in schematic:
  56                 [u8] param2
  57         }
  58
  59         Version changes:
  60         1 - Initial version
  61         2 - Fixed messy never/always place; 0 probability is now never, 0xFF is always
  62         3 - Added y-slice probabilities; this allows for variable height structures
  63 */
  64
  65 /////////////////// Schematic flags
  66 #define SCHEM_CIDS_UPDATED 0x08
  67
  68 #define MTSCHEM_FILE_SIGNATURE 0x4d54534d // 'MTSM'
  69 #define MTSCHEM_FILE_VER_HIGHEST_READ  3
  70 #define MTSCHEM_FILE_VER_HIGHEST_WRITE 3
  71
  72 #define MTSCHEM_PROB_NEVER  0x00
  73 #define MTSCHEM_PROB_ALWAYS 0xFF
  74
  75 enum SchematicType
  76 {
  77         SCHEMATIC_NORMAL,
  78 };
  79
  80 enum SchematicFormatType {
  81         SCHEM_FMT_HANDLE,
  82         SCHEM_FMT_MTS,
  83         SCHEM_FMT_LUA,
  84 };
  85
  86 class Schematic : public ObjDef, public NodeResolver {
  87 public:
  88         std::vector<content_t> c_nodes;
  89
  90         u32 flags;
  91         v3s16 size;
  92         MapNode *schemdata;
  93         u8 *slice_probs;
  94
  95         Schematic();
  96         virtual ~Schematic();
  97
  98         virtual void resolveNodeNames();
  99
 100         void updateContentIds();
 101
 102         void blitToVManip(v3s16 p, MMVManip *vm,
 103                 Rotation rot, bool force_placement, INodeDefManager *ndef);
 104
 105         bool loadSchematicFromFile(const std::string &filename, INodeDefManager *ndef,
 106                 StringMap *replace_names, NodeResolveMethod resolve_method);
 107         bool saveSchematicToFile(const std::string &filename);
 108         bool getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2);
 109
 110         bool deserializeFromMts(std::istream *is, std::vector<std::string> *names_out);
 111         bool serializeToMts(std::ostream *os);
 112         bool serializeToLua(std::ostream *os, bool use_comments);
 113
 114
 115         void placeStructure(Map *map, v3s16 p, u32 flags,
 116                 Rotation rot, bool force_placement, INodeDefManager *nef);
 117         void applyProbabilities(v3s16 p0,
 118                 std::vector<std::pair<v3s16, u8> > *plist,
 119                 std::vector<std::pair<s16, u8> > *splist);
 120 };
 121
 122 class SchematicManager : public ObjDefManager {
 123 public:
 124         SchematicManager(IGameDef *gamedef);
 125         virtual ~SchematicManager() {}
 126
 127         virtual void clear();
 128
 129         const char *getObjectTitle() const
 130         {
 131                 return "schematic";
 132         }
 133
 134         static Schematic *create(SchematicType type)
 135         {
 136                 return new Schematic;
 137         }
 138
 139 private:
 140         IGameDef *m_gamedef;
 141 };
 142
 143 void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
 144         std::vector<content_t> *usednodes);
 145
 146
 147 #endif