3 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
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.
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.
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.
20 #ifndef MG_SCHEMATIC_HEADER
21 #define MG_SCHEMATIC_HEADER
24 #include "mg_decoration.h"
25 #include "util/string.h"
34 Minetest Schematic File Format
36 All values are stored in big-endian byte order.
37 [u32] signature: 'MTSM'
43 [u8] slice probability value
44 [Name-ID table] Name ID Mapping Table
46 For each name-id mapping:
50 For each node in schematic: (for z, y, x)
52 For each node in schematic:
53 [u8] probability of occurance (param1)
54 For each node in schematic:
60 2 - Fixed messy never/always place; 0 probability is now never, 0xFF is always
61 3 - Added y-slice probabilities; this allows for variable height structures
64 /////////////////// Schematic flags
65 #define SCHEM_CIDS_UPDATED 0x08
67 #define MTSCHEM_FILE_SIGNATURE 0x4d54534d // 'MTSM'
68 #define MTSCHEM_FILE_VER_HIGHEST_READ 3
69 #define MTSCHEM_FILE_VER_HIGHEST_WRITE 3
71 #define MTSCHEM_PROB_NEVER 0x00
72 #define MTSCHEM_PROB_ALWAYS 0xFF
79 enum SchematicFormatType {
85 class Schematic : public ObjDef, public NodeResolver {
87 std::vector<content_t> c_nodes;
97 virtual void resolveNodeNames();
99 void updateContentIds();
101 void blitToVManip(v3s16 p, MMVManip *vm,
102 Rotation rot, bool force_placement, INodeDefManager *ndef);
104 bool loadSchematicFromFile(const std::string &filename, INodeDefManager *ndef,
105 StringMap *replace_names, NodeResolveMethod resolve_method);
106 bool saveSchematicToFile(const std::string &filename);
107 bool getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2);
109 bool deserializeFromMts(std::istream *is, std::vector<std::string> *names_out);
110 bool serializeToMts(std::ostream *os);
111 bool serializeToLua(std::ostream *os, bool use_comments);
114 void placeStructure(Map *map, v3s16 p, u32 flags,
115 Rotation rot, bool force_placement, INodeDefManager *nef);
116 void applyProbabilities(v3s16 p0,
117 std::vector<std::pair<v3s16, u8> > *plist,
118 std::vector<std::pair<s16, u8> > *splist);
121 class SchematicManager : public ObjDefManager {
123 SchematicManager(IGameDef *gamedef);
124 ~SchematicManager() {}
126 const char *getObjectTitle() const
131 static Schematic *create(SchematicType type)
133 return new Schematic;
137 void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
138 std::vector<content_t> *usednodes);