src/mg_schematic.h

   1 /*
   2 Minetest
   3 Copyright (C) 2014-2016 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   4 Copyright (C) 2015-2017 paramat
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #pragma once
  22
  23 #include <map>
  24 #include "mg_decoration.h"
  25 #include "util/string.h"
  26
  27 class Map;
  28 class ServerMap;
  29 class Mapgen;
  30 class MMVManip;
  31 class PseudoRandom;
  32 class NodeResolver;
  33 class Server;
  34
  35 /*
  36         Minetest Schematic File Format
  37
  38         All values are stored in big-endian byte order.
  39         [u32] signature: 'MTSM'
  40         [u16] version: 4
  41         [u16] size X
  42         [u16] size Y
  43         [u16] size Z
  44         For each Y:
  45                 [u8] slice probability value
  46         [Name-ID table] Name ID Mapping Table
  47                 [u16] name-id count
  48                 For each name-id mapping:
  49                         [u16] name length
  50                         [u8[]] name
  51         ZLib deflated {
  52         For each node in schematic:  (for z, y, x)
  53                 [u16] content
  54         For each node in schematic:
  55                 [u8] param1
  56                   bit 0-6: probability
  57                   bit 7:   specific node force placement
  58         For each node in schematic:
  59                 [u8] param2
  60         }
  61
  62         Version changes:
  63         1 - Initial version
  64         2 - Fixed messy never/always place; 0 probability is now never, 0xFF is always
  65         3 - Added y-slice probabilities; this allows for variable height structures
  66         4 - Compressed range of node occurence prob., added per-node force placement bit
  67 */
  68
  69 //// Schematic constants
  70 #define MTSCHEM_FILE_SIGNATURE 0x4d54534d // 'MTSM'
  71 #define MTSCHEM_FILE_VER_HIGHEST_READ  4
  72 #define MTSCHEM_FILE_VER_HIGHEST_WRITE 4
  73
  74 #define MTSCHEM_PROB_MASK       0x7F
  75
  76 #define MTSCHEM_PROB_NEVER      0x00
  77 #define MTSCHEM_PROB_ALWAYS     0x7F
  78 #define MTSCHEM_PROB_ALWAYS_OLD 0xFF
  79
  80 #define MTSCHEM_FORCE_PLACE     0x80
  81
  82 enum SchematicType
  83 {
  84         SCHEMATIC_NORMAL,
  85 };
  86
  87 enum SchematicFormatType {
  88         SCHEM_FMT_HANDLE,
  89         SCHEM_FMT_MTS,
  90         SCHEM_FMT_LUA,
  91 };
  92
  93 class Schematic : public ObjDef, public NodeResolver {
  94 public:
  95         Schematic();
  96         virtual ~Schematic();
  97
  98         virtual void resolveNodeNames();
  99
 100         bool loadSchematicFromFile(const std::string &filename, INodeDefManager *ndef,
 101                 StringMap *replace_names=NULL);
 102         bool saveSchematicToFile(const std::string &filename, INodeDefManager *ndef);
 103         bool getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2);
 104
 105         bool deserializeFromMts(std::istream *is, std::vector<std::string> *names);
 106         bool serializeToMts(std::ostream *os, const std::vector<std::string> &names);
 107         bool serializeToLua(std::ostream *os, const std::vector<std::string> &names,
 108                 bool use_comments, u32 indent_spaces);
 109
 110         void blitToVManip(MMVManip *vm, v3s16 p, Rotation rot, bool force_place);
 111         bool placeOnVManip(MMVManip *vm, v3s16 p, u32 flags, Rotation rot, bool force_place);
 112         void placeOnMap(ServerMap *map, v3s16 p, u32 flags, Rotation rot, bool force_place);
 113
 114         void applyProbabilities(v3s16 p0,
 115                 std::vector<std::pair<v3s16, u8> > *plist,
 116                 std::vector<std::pair<s16, u8> > *splist);
 117
 118         std::vector<content_t> c_nodes;
 119         u32 flags = 0;
 120         v3s16 size;
 121         MapNode *schemdata = nullptr;
 122         u8 *slice_probs = nullptr;
 123 };
 124
 125 class SchematicManager : public ObjDefManager {
 126 public:
 127         SchematicManager(Server *server);
 128         virtual ~SchematicManager() = default;
 129
 130         virtual void clear();
 131
 132         const char *getObjectTitle() const
 133         {
 134                 return "schematic";
 135         }
 136
 137         static Schematic *create(SchematicType type)
 138         {
 139                 return new Schematic;
 140         }
 141
 142 private:
 143         Server *m_server;
 144 };
 145
 146 void generate_nodelist_and_update_ids(MapNode *nodes, size_t nodecount,
 147         std::vector<std::string> *usednodes, INodeDefManager *ndef);