3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
22 #include "main.h" // For g_settings
29 #include "nameidmapping.h"
30 #include "util/numeric.h"
31 #include "util/serialize.h"
32 #include "exceptions.h"
41 type = NODEBOX_REGULAR;
44 // default is sign/ladder-like
45 wall_top = aabb3f(-BS/2, BS/2-BS/16., -BS/2, BS/2, BS/2, BS/2);
46 wall_bottom = aabb3f(-BS/2, -BS/2, -BS/2, BS/2, -BS/2+BS/16., BS/2);
47 wall_side = aabb3f(-BS/2, -BS/2, -BS/2, -BS/2+BS/16., BS/2, BS/2);
50 void NodeBox::serialize(std::ostream &os, u16 protocol_version) const
52 int version = protocol_version >= 21 ? 2 : 1;
55 if (version == 1 && type == NODEBOX_LEVELED)
56 writeU8(os, NODEBOX_FIXED);
60 if(type == NODEBOX_FIXED || type == NODEBOX_LEVELED)
62 writeU16(os, fixed.size());
63 for(std::vector<aabb3f>::const_iterator
65 i != fixed.end(); i++)
67 writeV3F1000(os, i->MinEdge);
68 writeV3F1000(os, i->MaxEdge);
71 else if(type == NODEBOX_WALLMOUNTED)
73 writeV3F1000(os, wall_top.MinEdge);
74 writeV3F1000(os, wall_top.MaxEdge);
75 writeV3F1000(os, wall_bottom.MinEdge);
76 writeV3F1000(os, wall_bottom.MaxEdge);
77 writeV3F1000(os, wall_side.MinEdge);
78 writeV3F1000(os, wall_side.MaxEdge);
82 void NodeBox::deSerialize(std::istream &is)
84 int version = readU8(is);
85 if(version < 1 || version > 2)
86 throw SerializationError("unsupported NodeBox version");
90 type = (enum NodeBoxType)readU8(is);
92 if(type == NODEBOX_FIXED || type == NODEBOX_LEVELED)
94 u16 fixed_count = readU16(is);
98 box.MinEdge = readV3F1000(is);
99 box.MaxEdge = readV3F1000(is);
100 fixed.push_back(box);
103 else if(type == NODEBOX_WALLMOUNTED)
105 wall_top.MinEdge = readV3F1000(is);
106 wall_top.MaxEdge = readV3F1000(is);
107 wall_bottom.MinEdge = readV3F1000(is);
108 wall_bottom.MaxEdge = readV3F1000(is);
109 wall_side.MinEdge = readV3F1000(is);
110 wall_side.MaxEdge = readV3F1000(is);
118 void TileDef::serialize(std::ostream &os, u16 protocol_version) const
120 if(protocol_version >= 17)
124 os<<serializeString(name);
125 writeU8(os, animation.type);
126 writeU16(os, animation.aspect_w);
127 writeU16(os, animation.aspect_h);
128 writeF1000(os, animation.length);
129 if(protocol_version >= 17)
130 writeU8(os, backface_culling);
133 void TileDef::deSerialize(std::istream &is)
135 int version = readU8(is);
136 name = deSerializeString(is);
137 animation.type = (TileAnimationType)readU8(is);
138 animation.aspect_w = readU16(is);
139 animation.aspect_h = readU16(is);
140 animation.length = readF1000(is);
142 backface_culling = readU8(is);
146 SimpleSoundSpec serialization
149 static void serializeSimpleSoundSpec(const SimpleSoundSpec &ss,
152 os<<serializeString(ss.name);
153 writeF1000(os, ss.gain);
155 static void deSerializeSimpleSoundSpec(SimpleSoundSpec &ss, std::istream &is)
157 ss.name = deSerializeString(is);
158 ss.gain = readF1000(is);
165 ContentFeatures::ContentFeatures()
170 ContentFeatures::~ContentFeatures()
174 void ContentFeatures::reset()
181 visual_solidness = 0;
182 backface_culling = true;
184 has_on_construct = false;
185 has_on_destruct = false;
186 has_after_destruct = false;
190 NOTE: Most of this is always overridden by the default values given
195 // Unknown nodes can be dug
196 groups["dig_immediate"] = 2;
197 drawtype = NDT_NORMAL;
199 for(u32 i = 0; i < 6; i++)
200 tiledef[i] = TileDef();
201 for(u16 j = 0; j < CF_SPECIAL_COUNT; j++)
202 tiledef_special[j] = TileDef();
204 post_effect_color = video::SColor(0, 0, 0, 0);
205 param_type = CPT_NONE;
206 param_type_2 = CPT2_NONE;
207 is_ground_content = false;
208 light_propagates = false;
209 sunlight_propagates = false;
214 buildable_to = false;
215 rightclickable = true;
217 liquid_type = LIQUID_NONE;
218 liquid_alternative_flowing = "";
219 liquid_alternative_source = "";
220 liquid_viscosity = 0;
221 liquid_renewable = true;
223 liquid_range = LIQUID_LEVEL_MAX+1;
226 damage_per_second = 0;
227 node_box = NodeBox();
228 selection_box = NodeBox();
230 legacy_facedir_simple = false;
231 legacy_wallmounted = false;
232 sound_footstep = SimpleSoundSpec();
233 sound_dig = SimpleSoundSpec("__group");
234 sound_dug = SimpleSoundSpec();
237 void ContentFeatures::serialize(std::ostream &os, u16 protocol_version)
239 if(protocol_version < 24){
240 serializeOld(os, protocol_version);
244 writeU8(os, 7); // version
245 os<<serializeString(name);
246 writeU16(os, groups.size());
247 for(ItemGroupList::const_iterator
248 i = groups.begin(); i != groups.end(); i++){
249 os<<serializeString(i->first);
250 writeS16(os, i->second);
252 writeU8(os, drawtype);
253 writeF1000(os, visual_scale);
255 for(u32 i = 0; i < 6; i++)
256 tiledef[i].serialize(os, protocol_version);
257 writeU8(os, CF_SPECIAL_COUNT);
258 for(u32 i = 0; i < CF_SPECIAL_COUNT; i++){
259 tiledef_special[i].serialize(os, protocol_version);
262 writeU8(os, post_effect_color.getAlpha());
263 writeU8(os, post_effect_color.getRed());
264 writeU8(os, post_effect_color.getGreen());
265 writeU8(os, post_effect_color.getBlue());
266 writeU8(os, param_type);
267 writeU8(os, param_type_2);
268 writeU8(os, is_ground_content);
269 writeU8(os, light_propagates);
270 writeU8(os, sunlight_propagates);
271 writeU8(os, walkable);
272 writeU8(os, pointable);
273 writeU8(os, diggable);
274 writeU8(os, climbable);
275 writeU8(os, buildable_to);
276 os<<serializeString(""); // legacy: used to be metadata_name
277 writeU8(os, liquid_type);
278 os<<serializeString(liquid_alternative_flowing);
279 os<<serializeString(liquid_alternative_source);
280 writeU8(os, liquid_viscosity);
281 writeU8(os, liquid_renewable);
282 writeU8(os, light_source);
283 writeU32(os, damage_per_second);
284 node_box.serialize(os, protocol_version);
285 selection_box.serialize(os, protocol_version);
286 writeU8(os, legacy_facedir_simple);
287 writeU8(os, legacy_wallmounted);
288 serializeSimpleSoundSpec(sound_footstep, os);
289 serializeSimpleSoundSpec(sound_dig, os);
290 serializeSimpleSoundSpec(sound_dug, os);
291 writeU8(os, rightclickable);
292 writeU8(os, drowning);
293 writeU8(os, leveled);
294 writeU8(os, liquid_range);
296 // Stuff below should be moved to correct place in a version that otherwise changes
297 // the protocol version
300 void ContentFeatures::deSerialize(std::istream &is)
302 int version = readU8(is);
304 deSerializeOld(is, version);
308 name = deSerializeString(is);
310 u32 groups_size = readU16(is);
311 for(u32 i = 0; i < groups_size; i++){
312 std::string name = deSerializeString(is);
313 int value = readS16(is);
314 groups[name] = value;
316 drawtype = (enum NodeDrawType)readU8(is);
317 visual_scale = readF1000(is);
319 throw SerializationError("unsupported tile count");
320 for(u32 i = 0; i < 6; i++)
321 tiledef[i].deSerialize(is);
322 if(readU8(is) != CF_SPECIAL_COUNT)
323 throw SerializationError("unsupported CF_SPECIAL_COUNT");
324 for(u32 i = 0; i < CF_SPECIAL_COUNT; i++)
325 tiledef_special[i].deSerialize(is);
327 post_effect_color.setAlpha(readU8(is));
328 post_effect_color.setRed(readU8(is));
329 post_effect_color.setGreen(readU8(is));
330 post_effect_color.setBlue(readU8(is));
331 param_type = (enum ContentParamType)readU8(is);
332 param_type_2 = (enum ContentParamType2)readU8(is);
333 is_ground_content = readU8(is);
334 light_propagates = readU8(is);
335 sunlight_propagates = readU8(is);
336 walkable = readU8(is);
337 pointable = readU8(is);
338 diggable = readU8(is);
339 climbable = readU8(is);
340 buildable_to = readU8(is);
341 deSerializeString(is); // legacy: used to be metadata_name
342 liquid_type = (enum LiquidType)readU8(is);
343 liquid_alternative_flowing = deSerializeString(is);
344 liquid_alternative_source = deSerializeString(is);
345 liquid_viscosity = readU8(is);
346 liquid_renewable = readU8(is);
347 light_source = readU8(is);
348 damage_per_second = readU32(is);
349 node_box.deSerialize(is);
350 selection_box.deSerialize(is);
351 legacy_facedir_simple = readU8(is);
352 legacy_wallmounted = readU8(is);
353 deSerializeSimpleSoundSpec(sound_footstep, is);
354 deSerializeSimpleSoundSpec(sound_dig, is);
355 deSerializeSimpleSoundSpec(sound_dug, is);
356 rightclickable = readU8(is);
357 drowning = readU8(is);
358 leveled = readU8(is);
359 liquid_range = readU8(is);
361 // If you add anything here, insert it primarily inside the try-catch
362 // block to not need to increase the version.
364 // Stuff below should be moved to correct place in a version that
365 // otherwise changes the protocol version
366 }catch(SerializationError &e) {};
373 class CNodeDefManager: public IWritableNodeDefManager {
376 virtual ~CNodeDefManager();
378 virtual IWritableNodeDefManager *clone();
379 virtual const ContentFeatures& get(content_t c) const;
380 virtual const ContentFeatures& get(const MapNode &n) const;
381 virtual bool getId(const std::string &name, content_t &result) const;
382 virtual content_t getId(const std::string &name) const;
383 virtual void getIds(const std::string &name, std::set<content_t> &result) const;
384 virtual const ContentFeatures& get(const std::string &name) const;
385 content_t allocateId();
386 virtual content_t set(const std::string &name, const ContentFeatures &def);
387 virtual content_t allocateDummy(const std::string &name);
388 virtual void updateAliases(IItemDefManager *idef);
389 virtual void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc);
390 void serialize(std::ostream &os, u16 protocol_version);
391 void deSerialize(std::istream &is);
394 void addNameIdMapping(content_t i, std::string name);
396 void fillTileAttribs(ITextureSource *tsrc, TileSpec *tile, TileDef *tiledef,
397 u32 shader_id, bool use_normal_texture, bool backface_culling,
398 u8 alpha, u8 material_type);
401 // Features indexed by id
402 std::vector<ContentFeatures> m_content_features;
404 // A mapping for fast converting back and forth between names and ids
405 NameIdMapping m_name_id_mapping;
407 // Like m_name_id_mapping, but only from names to ids, and includes
408 // item aliases too. Updated by updateAliases()
409 // Note: Not serialized.
411 std::map<std::string, content_t> m_name_id_mapping_with_aliases;
413 // A mapping from groups to a list of content_ts (and their levels)
414 // that belong to it. Necessary for a direct lookup in getIds().
415 // Note: Not serialized.
416 std::map<std::string, GroupItems> m_group_to_items;
418 // Next possibly free id
423 CNodeDefManager::CNodeDefManager()
429 CNodeDefManager::~CNodeDefManager()
434 void CNodeDefManager::clear()
436 m_content_features.clear();
437 m_name_id_mapping.clear();
438 m_name_id_mapping_with_aliases.clear();
439 m_group_to_items.clear();
442 u32 initial_length = 0;
443 initial_length = MYMAX(initial_length, CONTENT_UNKNOWN + 1);
444 initial_length = MYMAX(initial_length, CONTENT_AIR + 1);
445 initial_length = MYMAX(initial_length, CONTENT_IGNORE + 1);
446 m_content_features.resize(initial_length);
448 // Set CONTENT_UNKNOWN
452 // Insert directly into containers
453 content_t c = CONTENT_UNKNOWN;
454 m_content_features[c] = f;
455 addNameIdMapping(c, f.name);
462 f.drawtype = NDT_AIRLIKE;
463 f.param_type = CPT_LIGHT;
464 f.light_propagates = true;
465 f.sunlight_propagates = true;
469 f.buildable_to = true;
470 f.is_ground_content = true;
471 // Insert directly into containers
472 content_t c = CONTENT_AIR;
473 m_content_features[c] = f;
474 addNameIdMapping(c, f.name);
477 // Set CONTENT_IGNORE
481 f.drawtype = NDT_AIRLIKE;
482 f.param_type = CPT_NONE;
483 f.light_propagates = false;
484 f.sunlight_propagates = false;
488 f.buildable_to = true; // A way to remove accidental CONTENT_IGNOREs
489 f.is_ground_content = true;
490 // Insert directly into containers
491 content_t c = CONTENT_IGNORE;
492 m_content_features[c] = f;
493 addNameIdMapping(c, f.name);
498 IWritableNodeDefManager *CNodeDefManager::clone()
500 CNodeDefManager *mgr = new CNodeDefManager();
506 const ContentFeatures& CNodeDefManager::get(content_t c) const
508 if (c < m_content_features.size())
509 return m_content_features[c];
511 return m_content_features[CONTENT_UNKNOWN];
515 const ContentFeatures& CNodeDefManager::get(const MapNode &n) const
517 return get(n.getContent());
521 bool CNodeDefManager::getId(const std::string &name, content_t &result) const
523 std::map<std::string, content_t>::const_iterator
524 i = m_name_id_mapping_with_aliases.find(name);
525 if(i == m_name_id_mapping_with_aliases.end())
532 content_t CNodeDefManager::getId(const std::string &name) const
534 content_t id = CONTENT_IGNORE;
540 void CNodeDefManager::getIds(const std::string &name,
541 std::set<content_t> &result) const
543 //TimeTaker t("getIds", NULL, PRECISION_MICRO);
544 if (name.substr(0,6) != "group:") {
545 content_t id = CONTENT_IGNORE;
550 std::string group = name.substr(6);
552 std::map<std::string, GroupItems>::const_iterator
553 i = m_group_to_items.find(group);
554 if (i == m_group_to_items.end())
557 const GroupItems &items = i->second;
558 for (GroupItems::const_iterator j = items.begin();
559 j != items.end(); ++j) {
560 if ((*j).second != 0)
561 result.insert((*j).first);
563 //printf("getIds: %dus\n", t.stop());
567 const ContentFeatures& CNodeDefManager::get(const std::string &name) const
569 content_t id = CONTENT_UNKNOWN;
575 // returns CONTENT_IGNORE if no free ID found
576 content_t CNodeDefManager::allocateId()
578 for (content_t id = m_next_id;
579 id >= m_next_id; // overflow?
581 while (id >= m_content_features.size()) {
582 m_content_features.push_back(ContentFeatures());
584 const ContentFeatures &f = m_content_features[id];
590 // If we arrive here, an overflow occurred in id.
591 // That means no ID was found
592 return CONTENT_IGNORE;
596 // IWritableNodeDefManager
597 content_t CNodeDefManager::set(const std::string &name, const ContentFeatures &def)
600 assert(name == def.name);
602 // Don't allow redefining ignore (but allow air and unknown)
603 if (name == "ignore") {
604 infostream << "NodeDefManager: WARNING: Ignoring "
605 "CONTENT_IGNORE redefinition"<<std::endl;
606 return CONTENT_IGNORE;
609 content_t id = CONTENT_IGNORE;
610 if (!m_name_id_mapping.getId(name, id)) { // ignore aliases
613 if (id == CONTENT_IGNORE) {
614 infostream << "NodeDefManager: WARNING: Absolute "
615 "limit reached" << std::endl;
616 return CONTENT_IGNORE;
618 assert(id != CONTENT_IGNORE);
619 addNameIdMapping(id, name);
621 m_content_features[id] = def;
622 verbosestream << "NodeDefManager: registering content id \"" << id
623 << "\": name=\"" << def.name << "\""<<std::endl;
625 // Add this content to the list of all groups it belongs to
626 // FIXME: This should remove a node from groups it no longer
627 // belongs to when a node is re-registered
628 for (ItemGroupList::const_iterator i = def.groups.begin();
629 i != def.groups.end(); ++i) {
630 std::string group_name = i->first;
632 std::map<std::string, GroupItems>::iterator
633 j = m_group_to_items.find(group_name);
634 if (j == m_group_to_items.end()) {
635 m_group_to_items[group_name].push_back(
636 std::make_pair(id, i->second));
638 GroupItems &items = j->second;
639 items.push_back(std::make_pair(id, i->second));
646 content_t CNodeDefManager::allocateDummy(const std::string &name)
655 void CNodeDefManager::updateAliases(IItemDefManager *idef)
657 std::set<std::string> all = idef->getAll();
658 m_name_id_mapping_with_aliases.clear();
659 for (std::set<std::string>::iterator
660 i = all.begin(); i != all.end(); i++) {
661 std::string name = *i;
662 std::string convert_to = idef->getAlias(name);
664 if (m_name_id_mapping.getId(convert_to, id)) {
665 m_name_id_mapping_with_aliases.insert(
666 std::make_pair(name, id));
672 void CNodeDefManager::updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc)
675 infostream << "CNodeDefManager::updateTextures(): Updating "
676 "textures in node definitions" << std::endl;
678 bool new_style_water = g_settings->getBool("new_style_water");
679 bool new_style_leaves = g_settings->getBool("new_style_leaves");
680 bool connected_glass = g_settings->getBool("connected_glass");
681 bool opaque_water = g_settings->getBool("opaque_water");
682 bool enable_shaders = g_settings->getBool("enable_shaders");
683 bool enable_bumpmapping = g_settings->getBool("enable_bumpmapping");
684 bool enable_parallax_occlusion = g_settings->getBool("enable_parallax_occlusion");
686 bool use_normal_texture = enable_shaders &&
687 (enable_bumpmapping || enable_parallax_occlusion);
689 for (u32 i = 0; i < m_content_features.size(); i++) {
690 ContentFeatures *f = &m_content_features[i];
692 // Figure out the actual tiles to use
694 for (u32 j = 0; j < 6; j++) {
695 tiledef[j] = f->tiledef[j];
696 if (tiledef[j].name == "")
697 tiledef[j].name = "unknown_node.png";
700 bool is_liquid = false;
701 bool is_water_surface = false;
703 u8 material_type = (f->alpha == 255) ?
704 TILE_MATERIAL_BASIC : TILE_MATERIAL_ALPHA;
706 switch (f->drawtype) {
715 assert(f->liquid_type == LIQUID_SOURCE);
718 if (new_style_water){
722 f->backface_culling = false;
726 case NDT_FLOWINGLIQUID:
727 assert(f->liquid_type == LIQUID_FLOWING);
735 f->visual_solidness = 1;
737 case NDT_GLASSLIKE_FRAMED:
739 f->visual_solidness = 1;
741 case NDT_GLASSLIKE_FRAMED_OPTIONAL:
743 f->visual_solidness = 1;
744 f->drawtype = connected_glass ? NDT_GLASSLIKE_FRAMED : NDT_GLASSLIKE;
748 f->visual_solidness = 1;
750 case NDT_ALLFACES_OPTIONAL:
751 if (new_style_leaves) {
752 f->drawtype = NDT_ALLFACES;
754 f->visual_solidness = 1;
756 f->drawtype = NDT_NORMAL;
758 for (u32 i = 0; i < 6; i++)
759 tiledef[i].name += std::string("^[noalpha");
762 material_type = TILE_MATERIAL_WAVING_LEAVES;
766 f->backface_culling = false;
768 material_type = TILE_MATERIAL_WAVING_PLANTS;
771 f->backface_culling = false;
784 material_type = (f->alpha == 255) ?
785 TILE_MATERIAL_LIQUID_OPAQUE : TILE_MATERIAL_LIQUID_TRANSPARENT;
786 if (f->name == "default:water_source")
787 is_water_surface = true;
791 for (u16 j = 0; j < 6; j++) {
792 tile_shader[j] = shdsrc->getShader("nodes_shader",
793 material_type, f->drawtype);
796 if (is_water_surface) {
797 tile_shader[0] = shdsrc->getShader("water_surface_shader",
798 material_type, f->drawtype);
801 // Tiles (fill in f->tiles[])
802 for (u16 j = 0; j < 6; j++) {
803 fillTileAttribs(tsrc, &f->tiles[j], &tiledef[j], tile_shader[j],
804 use_normal_texture, f->backface_culling, f->alpha, material_type);
807 // Special tiles (fill in f->special_tiles[])
808 for (u16 j = 0; j < CF_SPECIAL_COUNT; j++) {
809 fillTileAttribs(tsrc, &f->special_tiles[j], &f->tiledef_special[j],
810 tile_shader[j], use_normal_texture,
811 f->tiledef_special[j].backface_culling, f->alpha, material_type);
819 void CNodeDefManager::fillTileAttribs(ITextureSource *tsrc, TileSpec *tile,
820 TileDef *tiledef, u32 shader_id, bool use_normal_texture,
821 bool backface_culling, u8 alpha, u8 material_type)
823 tile->shader_id = shader_id;
824 tile->texture = tsrc->getTexture(tiledef->name, &tile->texture_id);
826 tile->material_type = material_type;
829 if (use_normal_texture)
830 tile->normal_texture = tsrc->getNormalTexture(tiledef->name);
833 tile->material_flags = 0;
834 if (backface_culling)
835 tile->material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
836 if (tiledef->animation.type == TAT_VERTICAL_FRAMES)
837 tile->material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
839 // Animation parameters
841 if (tile->material_flags & MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES) {
842 // Get texture size to determine frame count by aspect ratio
843 v2u32 size = tile->texture->getOriginalSize();
844 int frame_height = (float)size.X /
845 (float)tiledef->animation.aspect_w *
846 (float)tiledef->animation.aspect_h;
847 frame_count = size.Y / frame_height;
848 int frame_length_ms = 1000.0 * tiledef->animation.length / frame_count;
849 tile->animation_frame_count = frame_count;
850 tile->animation_frame_length_ms = frame_length_ms;
853 if (frame_count == 1) {
854 tile->material_flags &= ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
856 std::ostringstream os(std::ios::binary);
857 for (int i = 0; i < frame_count; i++) {
861 os << tiledef->name << "^[verticalframe:"
862 << frame_count << ":" << i;
864 frame.texture = tsrc->getTexture(os.str(), &frame.texture_id);
865 if (tile->normal_texture)
866 frame.normal_texture = tsrc->getNormalTexture(os.str());
867 tile->frames[i] = frame;
874 void CNodeDefManager::serialize(std::ostream &os, u16 protocol_version)
876 writeU8(os, 1); // version
878 std::ostringstream os2(std::ios::binary);
879 for (u32 i = 0; i < m_content_features.size(); i++) {
880 if (i == CONTENT_IGNORE || i == CONTENT_AIR
881 || i == CONTENT_UNKNOWN)
883 ContentFeatures *f = &m_content_features[i];
887 // Wrap it in a string to allow different lengths without
888 // strict version incompatibilities
889 std::ostringstream wrapper_os(std::ios::binary);
890 f->serialize(wrapper_os, protocol_version);
891 os2<<serializeString(wrapper_os.str());
893 assert(count + 1 > count); // must not overflow
897 os << serializeLongString(os2.str());
901 void CNodeDefManager::deSerialize(std::istream &is)
904 int version = readU8(is);
906 throw SerializationError("unsupported NodeDefinitionManager version");
907 u16 count = readU16(is);
908 std::istringstream is2(deSerializeLongString(is), std::ios::binary);
910 for (u16 n = 0; n < count; n++) {
911 u16 i = readU16(is2);
913 // Read it from the string wrapper
914 std::string wrapper = deSerializeString(is2);
915 std::istringstream wrapper_is(wrapper, std::ios::binary);
916 f.deSerialize(wrapper_is);
918 // Check error conditions
919 if (i == CONTENT_IGNORE || i == CONTENT_AIR || i == CONTENT_UNKNOWN) {
920 infostream << "NodeDefManager::deSerialize(): WARNING: "
921 "not changing builtin node " << i << std::endl;
925 infostream << "NodeDefManager::deSerialize(): WARNING: "
926 "received empty name" << std::endl;
932 if (m_name_id_mapping.getId(f.name, existing_id) && i != existing_id) {
933 infostream << "NodeDefManager::deSerialize(): WARNING: "
934 "already defined with different ID: " << f.name << std::endl;
938 // All is ok, add node definition with the requested ID
939 if (i >= m_content_features.size())
940 m_content_features.resize((u32)(i) + 1);
941 m_content_features[i] = f;
942 addNameIdMapping(i, f.name);
943 verbosestream << "deserialized " << f.name << std::endl;
948 void CNodeDefManager::addNameIdMapping(content_t i, std::string name)
950 m_name_id_mapping.set(i, name);
951 m_name_id_mapping_with_aliases.insert(std::make_pair(name, i));
955 IWritableNodeDefManager *createNodeDefManager()
957 return new CNodeDefManager();
961 //// Serialization of old ContentFeatures formats
962 void ContentFeatures::serializeOld(std::ostream &os, u16 protocol_version)
964 if (protocol_version == 13)
966 writeU8(os, 5); // version
967 os<<serializeString(name);
968 writeU16(os, groups.size());
969 for (ItemGroupList::const_iterator
970 i = groups.begin(); i != groups.end(); i++) {
971 os<<serializeString(i->first);
972 writeS16(os, i->second);
974 writeU8(os, drawtype);
975 writeF1000(os, visual_scale);
977 for (u32 i = 0; i < 6; i++)
978 tiledef[i].serialize(os, protocol_version);
979 //CF_SPECIAL_COUNT = 2 before cf ver. 7 and protocol ver. 24
981 for (u32 i = 0; i < 2; i++)
982 tiledef_special[i].serialize(os, protocol_version);
984 writeU8(os, post_effect_color.getAlpha());
985 writeU8(os, post_effect_color.getRed());
986 writeU8(os, post_effect_color.getGreen());
987 writeU8(os, post_effect_color.getBlue());
988 writeU8(os, param_type);
989 writeU8(os, param_type_2);
990 writeU8(os, is_ground_content);
991 writeU8(os, light_propagates);
992 writeU8(os, sunlight_propagates);
993 writeU8(os, walkable);
994 writeU8(os, pointable);
995 writeU8(os, diggable);
996 writeU8(os, climbable);
997 writeU8(os, buildable_to);
998 os<<serializeString(""); // legacy: used to be metadata_name
999 writeU8(os, liquid_type);
1000 os<<serializeString(liquid_alternative_flowing);
1001 os<<serializeString(liquid_alternative_source);
1002 writeU8(os, liquid_viscosity);
1003 writeU8(os, light_source);
1004 writeU32(os, damage_per_second);
1005 node_box.serialize(os, protocol_version);
1006 selection_box.serialize(os, protocol_version);
1007 writeU8(os, legacy_facedir_simple);
1008 writeU8(os, legacy_wallmounted);
1009 serializeSimpleSoundSpec(sound_footstep, os);
1010 serializeSimpleSoundSpec(sound_dig, os);
1011 serializeSimpleSoundSpec(sound_dug, os);
1013 else if (protocol_version > 13 && protocol_version < 24) {
1014 writeU8(os, 6); // version
1015 os<<serializeString(name);
1016 writeU16(os, groups.size());
1017 for (ItemGroupList::const_iterator
1018 i = groups.begin(); i != groups.end(); i++) {
1019 os<<serializeString(i->first);
1020 writeS16(os, i->second);
1022 writeU8(os, drawtype);
1023 writeF1000(os, visual_scale);
1025 for (u32 i = 0; i < 6; i++)
1026 tiledef[i].serialize(os, protocol_version);
1027 //CF_SPECIAL_COUNT = 2 before cf ver. 7 and protocol ver. 24
1029 for (u32 i = 0; i < 2; i++)
1030 tiledef_special[i].serialize(os, protocol_version);
1032 writeU8(os, post_effect_color.getAlpha());
1033 writeU8(os, post_effect_color.getRed());
1034 writeU8(os, post_effect_color.getGreen());
1035 writeU8(os, post_effect_color.getBlue());
1036 writeU8(os, param_type);
1037 writeU8(os, param_type_2);
1038 writeU8(os, is_ground_content);
1039 writeU8(os, light_propagates);
1040 writeU8(os, sunlight_propagates);
1041 writeU8(os, walkable);
1042 writeU8(os, pointable);
1043 writeU8(os, diggable);
1044 writeU8(os, climbable);
1045 writeU8(os, buildable_to);
1046 os<<serializeString(""); // legacy: used to be metadata_name
1047 writeU8(os, liquid_type);
1048 os<<serializeString(liquid_alternative_flowing);
1049 os<<serializeString(liquid_alternative_source);
1050 writeU8(os, liquid_viscosity);
1051 writeU8(os, liquid_renewable);
1052 writeU8(os, light_source);
1053 writeU32(os, damage_per_second);
1054 node_box.serialize(os, protocol_version);
1055 selection_box.serialize(os, protocol_version);
1056 writeU8(os, legacy_facedir_simple);
1057 writeU8(os, legacy_wallmounted);
1058 serializeSimpleSoundSpec(sound_footstep, os);
1059 serializeSimpleSoundSpec(sound_dig, os);
1060 serializeSimpleSoundSpec(sound_dug, os);
1061 writeU8(os, rightclickable);
1062 writeU8(os, drowning);
1063 writeU8(os, leveled);
1064 writeU8(os, liquid_range);
1066 throw SerializationError("ContentFeatures::serialize(): "
1067 "Unsupported version requested");
1071 void ContentFeatures::deSerializeOld(std::istream &is, int version)
1073 if (version == 5) // In PROTOCOL_VERSION 13
1075 name = deSerializeString(is);
1077 u32 groups_size = readU16(is);
1078 for(u32 i=0; i<groups_size; i++){
1079 std::string name = deSerializeString(is);
1080 int value = readS16(is);
1081 groups[name] = value;
1083 drawtype = (enum NodeDrawType)readU8(is);
1084 visual_scale = readF1000(is);
1085 if (readU8(is) != 6)
1086 throw SerializationError("unsupported tile count");
1087 for (u32 i = 0; i < 6; i++)
1088 tiledef[i].deSerialize(is);
1089 if (readU8(is) != CF_SPECIAL_COUNT)
1090 throw SerializationError("unsupported CF_SPECIAL_COUNT");
1091 for (u32 i = 0; i < CF_SPECIAL_COUNT; i++)
1092 tiledef_special[i].deSerialize(is);
1094 post_effect_color.setAlpha(readU8(is));
1095 post_effect_color.setRed(readU8(is));
1096 post_effect_color.setGreen(readU8(is));
1097 post_effect_color.setBlue(readU8(is));
1098 param_type = (enum ContentParamType)readU8(is);
1099 param_type_2 = (enum ContentParamType2)readU8(is);
1100 is_ground_content = readU8(is);
1101 light_propagates = readU8(is);
1102 sunlight_propagates = readU8(is);
1103 walkable = readU8(is);
1104 pointable = readU8(is);
1105 diggable = readU8(is);
1106 climbable = readU8(is);
1107 buildable_to = readU8(is);
1108 deSerializeString(is); // legacy: used to be metadata_name
1109 liquid_type = (enum LiquidType)readU8(is);
1110 liquid_alternative_flowing = deSerializeString(is);
1111 liquid_alternative_source = deSerializeString(is);
1112 liquid_viscosity = readU8(is);
1113 light_source = readU8(is);
1114 damage_per_second = readU32(is);
1115 node_box.deSerialize(is);
1116 selection_box.deSerialize(is);
1117 legacy_facedir_simple = readU8(is);
1118 legacy_wallmounted = readU8(is);
1119 deSerializeSimpleSoundSpec(sound_footstep, is);
1120 deSerializeSimpleSoundSpec(sound_dig, is);
1121 deSerializeSimpleSoundSpec(sound_dug, is);
1122 } else if (version == 6) {
1123 name = deSerializeString(is);
1125 u32 groups_size = readU16(is);
1126 for (u32 i = 0; i < groups_size; i++) {
1127 std::string name = deSerializeString(is);
1128 int value = readS16(is);
1129 groups[name] = value;
1131 drawtype = (enum NodeDrawType)readU8(is);
1132 visual_scale = readF1000(is);
1133 if (readU8(is) != 6)
1134 throw SerializationError("unsupported tile count");
1135 for (u32 i = 0; i < 6; i++)
1136 tiledef[i].deSerialize(is);
1137 // CF_SPECIAL_COUNT in version 6 = 2
1138 if (readU8(is) != 2)
1139 throw SerializationError("unsupported CF_SPECIAL_COUNT");
1140 for (u32 i = 0; i < 2; i++)
1141 tiledef_special[i].deSerialize(is);
1143 post_effect_color.setAlpha(readU8(is));
1144 post_effect_color.setRed(readU8(is));
1145 post_effect_color.setGreen(readU8(is));
1146 post_effect_color.setBlue(readU8(is));
1147 param_type = (enum ContentParamType)readU8(is);
1148 param_type_2 = (enum ContentParamType2)readU8(is);
1149 is_ground_content = readU8(is);
1150 light_propagates = readU8(is);
1151 sunlight_propagates = readU8(is);
1152 walkable = readU8(is);
1153 pointable = readU8(is);
1154 diggable = readU8(is);
1155 climbable = readU8(is);
1156 buildable_to = readU8(is);
1157 deSerializeString(is); // legacy: used to be metadata_name
1158 liquid_type = (enum LiquidType)readU8(is);
1159 liquid_alternative_flowing = deSerializeString(is);
1160 liquid_alternative_source = deSerializeString(is);
1161 liquid_viscosity = readU8(is);
1162 liquid_renewable = readU8(is);
1163 light_source = readU8(is);
1164 damage_per_second = readU32(is);
1165 node_box.deSerialize(is);
1166 selection_box.deSerialize(is);
1167 legacy_facedir_simple = readU8(is);
1168 legacy_wallmounted = readU8(is);
1169 deSerializeSimpleSoundSpec(sound_footstep, is);
1170 deSerializeSimpleSoundSpec(sound_dig, is);
1171 deSerializeSimpleSoundSpec(sound_dug, is);
1172 rightclickable = readU8(is);
1173 drowning = readU8(is);
1174 leveled = readU8(is);
1175 liquid_range = readU8(is);
1177 throw SerializationError("unsupported ContentFeatures version");