3 Copyright (C) 2010 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/serialize.h"
38 type = NODEBOX_REGULAR;
41 // default is sign/ladder-like
42 wall_top = aabb3f(-BS/2, BS/2-BS/16., -BS/2, BS/2, BS/2, BS/2);
43 wall_bottom = aabb3f(-BS/2, -BS/2, -BS/2, BS/2, -BS/2+BS/16., BS/2);
44 wall_side = aabb3f(-BS/2, -BS/2, -BS/2, -BS/2+BS/16., BS/2, BS/2);
47 void NodeBox::serialize(std::ostream &os) const
49 writeU8(os, 1); // version
52 if(type == NODEBOX_FIXED)
54 writeU16(os, fixed.size());
55 for(std::vector<aabb3f>::const_iterator
57 i != fixed.end(); i++)
59 writeV3F1000(os, i->MinEdge);
60 writeV3F1000(os, i->MaxEdge);
63 else if(type == NODEBOX_WALLMOUNTED)
65 writeV3F1000(os, wall_top.MinEdge);
66 writeV3F1000(os, wall_top.MaxEdge);
67 writeV3F1000(os, wall_bottom.MinEdge);
68 writeV3F1000(os, wall_bottom.MaxEdge);
69 writeV3F1000(os, wall_side.MinEdge);
70 writeV3F1000(os, wall_side.MaxEdge);
74 void NodeBox::deSerialize(std::istream &is)
76 int version = readU8(is);
78 throw SerializationError("unsupported NodeBox version");
82 type = (enum NodeBoxType)readU8(is);
84 if(type == NODEBOX_FIXED)
86 u16 fixed_count = readU16(is);
90 box.MinEdge = readV3F1000(is);
91 box.MaxEdge = readV3F1000(is);
95 else if(type == NODEBOX_WALLMOUNTED)
97 wall_top.MinEdge = readV3F1000(is);
98 wall_top.MaxEdge = readV3F1000(is);
99 wall_bottom.MinEdge = readV3F1000(is);
100 wall_bottom.MaxEdge = readV3F1000(is);
101 wall_side.MinEdge = readV3F1000(is);
102 wall_side.MaxEdge = readV3F1000(is);
110 void TileDef::serialize(std::ostream &os) const
112 writeU8(os, 0); // version
113 os<<serializeString(name);
114 writeU8(os, animation.type);
115 writeU16(os, animation.aspect_w);
116 writeU16(os, animation.aspect_h);
117 writeF1000(os, animation.length);
120 void TileDef::deSerialize(std::istream &is)
122 int version = readU8(is);
124 throw SerializationError("unsupported TileDef version");
125 name = deSerializeString(is);
126 animation.type = (TileAnimationType)readU8(is);
127 animation.aspect_w = readU16(is);
128 animation.aspect_h = readU16(is);
129 animation.length = readF1000(is);
133 SimpleSoundSpec serialization
136 static void serializeSimpleSoundSpec(const SimpleSoundSpec &ss,
139 os<<serializeString(ss.name);
140 writeF1000(os, ss.gain);
142 static void deSerializeSimpleSoundSpec(SimpleSoundSpec &ss, std::istream &is)
144 ss.name = deSerializeString(is);
145 ss.gain = readF1000(is);
152 ContentFeatures::ContentFeatures()
157 ContentFeatures::~ContentFeatures()
161 void ContentFeatures::reset()
168 visual_solidness = 0;
169 backface_culling = true;
171 has_on_construct = false;
172 has_on_destruct = false;
173 has_after_destruct = false;
177 NOTE: Most of this is always overridden by the default values given
182 // Unknown nodes can be dug
183 groups["dig_immediate"] = 2;
184 drawtype = NDT_NORMAL;
186 for(u32 i=0; i<6; i++)
187 tiledef[i] = TileDef();
188 for(u16 j=0; j<CF_SPECIAL_COUNT; j++)
189 tiledef_special[j] = TileDef();
191 post_effect_color = video::SColor(0, 0, 0, 0);
192 param_type = CPT_NONE;
193 param_type_2 = CPT2_NONE;
194 is_ground_content = false;
195 light_propagates = false;
196 sunlight_propagates = false;
201 buildable_to = false;
202 liquid_type = LIQUID_NONE;
203 liquid_alternative_flowing = "";
204 liquid_alternative_source = "";
205 liquid_viscosity = 0;
206 liquid_renewable = true;
208 damage_per_second = 0;
209 node_box = NodeBox();
210 selection_box = NodeBox();
211 legacy_facedir_simple = false;
212 legacy_wallmounted = false;
213 sound_footstep = SimpleSoundSpec();
214 sound_dig = SimpleSoundSpec("__group");
215 sound_dug = SimpleSoundSpec();
218 void ContentFeatures::serialize(std::ostream &os)
220 writeU8(os, 6); // version
221 os<<serializeString(name);
222 writeU16(os, groups.size());
223 for(ItemGroupList::const_iterator
224 i = groups.begin(); i != groups.end(); i++){
225 os<<serializeString(i->first);
226 writeS16(os, i->second);
228 writeU8(os, drawtype);
229 writeF1000(os, visual_scale);
231 for(u32 i=0; i<6; i++)
232 tiledef[i].serialize(os);
233 writeU8(os, CF_SPECIAL_COUNT);
234 for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
235 tiledef_special[i].serialize(os);
238 writeU8(os, post_effect_color.getAlpha());
239 writeU8(os, post_effect_color.getRed());
240 writeU8(os, post_effect_color.getGreen());
241 writeU8(os, post_effect_color.getBlue());
242 writeU8(os, param_type);
243 writeU8(os, param_type_2);
244 writeU8(os, is_ground_content);
245 writeU8(os, light_propagates);
246 writeU8(os, sunlight_propagates);
247 writeU8(os, walkable);
248 writeU8(os, pointable);
249 writeU8(os, diggable);
250 writeU8(os, climbable);
251 writeU8(os, buildable_to);
252 os<<serializeString(""); // legacy: used to be metadata_name
253 writeU8(os, liquid_type);
254 os<<serializeString(liquid_alternative_flowing);
255 os<<serializeString(liquid_alternative_source);
256 writeU8(os, liquid_viscosity);
257 writeU8(os, liquid_renewable);
258 writeU8(os, light_source);
259 writeU32(os, damage_per_second);
260 node_box.serialize(os);
261 selection_box.serialize(os);
262 writeU8(os, legacy_facedir_simple);
263 writeU8(os, legacy_wallmounted);
264 serializeSimpleSoundSpec(sound_footstep, os);
265 serializeSimpleSoundSpec(sound_dig, os);
266 serializeSimpleSoundSpec(sound_dug, os);
267 // Stuff below should be moved to correct place in a version that otherwise changes
268 // the protocol version
271 void ContentFeatures::deSerialize(std::istream &is)
273 int version = readU8(is);
274 if(version == 6) // In PROTOCOL_VERSION 14
276 name = deSerializeString(is);
278 u32 groups_size = readU16(is);
279 for(u32 i=0; i<groups_size; i++){
280 std::string name = deSerializeString(is);
281 int value = readS16(is);
282 groups[name] = value;
284 drawtype = (enum NodeDrawType)readU8(is);
285 visual_scale = readF1000(is);
287 throw SerializationError("unsupported tile count");
288 for(u32 i=0; i<6; i++)
289 tiledef[i].deSerialize(is);
290 if(readU8(is) != CF_SPECIAL_COUNT)
291 throw SerializationError("unsupported CF_SPECIAL_COUNT");
292 for(u32 i=0; i<CF_SPECIAL_COUNT; i++)
293 tiledef_special[i].deSerialize(is);
295 post_effect_color.setAlpha(readU8(is));
296 post_effect_color.setRed(readU8(is));
297 post_effect_color.setGreen(readU8(is));
298 post_effect_color.setBlue(readU8(is));
299 param_type = (enum ContentParamType)readU8(is);
300 param_type_2 = (enum ContentParamType2)readU8(is);
301 is_ground_content = readU8(is);
302 light_propagates = readU8(is);
303 sunlight_propagates = readU8(is);
304 walkable = readU8(is);
305 pointable = readU8(is);
306 diggable = readU8(is);
307 climbable = readU8(is);
308 buildable_to = readU8(is);
309 deSerializeString(is); // legacy: used to be metadata_name
310 liquid_type = (enum LiquidType)readU8(is);
311 liquid_alternative_flowing = deSerializeString(is);
312 liquid_alternative_source = deSerializeString(is);
313 liquid_viscosity = readU8(is);
314 liquid_renewable = readU8(is);
315 light_source = readU8(is);
316 damage_per_second = readU32(is);
317 node_box.deSerialize(is);
318 selection_box.deSerialize(is);
319 legacy_facedir_simple = readU8(is);
320 legacy_wallmounted = readU8(is);
321 deSerializeSimpleSoundSpec(sound_footstep, is);
322 deSerializeSimpleSoundSpec(sound_dig, is);
323 deSerializeSimpleSoundSpec(sound_dug, is);
324 // If you add anything here, insert it primarily inside the try-catch
325 // block to not need to increase the version.
327 // Stuff below should be moved to correct place in a version that
328 // otherwise changes the protocol version
329 }catch(SerializationError &e) {};
331 else if(version == 5) // In PROTOCOL_VERSION 13
333 name = deSerializeString(is);
335 u32 groups_size = readU16(is);
336 for(u32 i=0; i<groups_size; i++){
337 std::string name = deSerializeString(is);
338 int value = readS16(is);
339 groups[name] = value;
341 drawtype = (enum NodeDrawType)readU8(is);
342 visual_scale = readF1000(is);
344 throw SerializationError("unsupported tile count");
345 for(u32 i=0; i<6; i++)
346 tiledef[i].deSerialize(is);
347 if(readU8(is) != CF_SPECIAL_COUNT)
348 throw SerializationError("unsupported CF_SPECIAL_COUNT");
349 for(u32 i=0; i<CF_SPECIAL_COUNT; i++)
350 tiledef_special[i].deSerialize(is);
352 post_effect_color.setAlpha(readU8(is));
353 post_effect_color.setRed(readU8(is));
354 post_effect_color.setGreen(readU8(is));
355 post_effect_color.setBlue(readU8(is));
356 param_type = (enum ContentParamType)readU8(is);
357 param_type_2 = (enum ContentParamType2)readU8(is);
358 is_ground_content = readU8(is);
359 light_propagates = readU8(is);
360 sunlight_propagates = readU8(is);
361 walkable = readU8(is);
362 pointable = readU8(is);
363 diggable = readU8(is);
364 climbable = readU8(is);
365 buildable_to = readU8(is);
366 deSerializeString(is); // legacy: used to be metadata_name
367 liquid_type = (enum LiquidType)readU8(is);
368 liquid_alternative_flowing = deSerializeString(is);
369 liquid_alternative_source = deSerializeString(is);
370 liquid_viscosity = readU8(is);
371 light_source = readU8(is);
372 damage_per_second = readU32(is);
373 node_box.deSerialize(is);
374 selection_box.deSerialize(is);
375 legacy_facedir_simple = readU8(is);
376 legacy_wallmounted = readU8(is);
377 deSerializeSimpleSoundSpec(sound_footstep, is);
378 deSerializeSimpleSoundSpec(sound_dig, is);
379 deSerializeSimpleSoundSpec(sound_dug, is);
383 throw SerializationError("unsupported ContentFeatures version");
391 class CNodeDefManager: public IWritableNodeDefManager
396 m_name_id_mapping.clear();
397 m_name_id_mapping_with_aliases.clear();
399 for(u16 i=0; i<=MAX_CONTENT; i++)
401 ContentFeatures &f = m_content_features[i];
402 f.reset(); // Reset to defaults
409 f.drawtype = NDT_AIRLIKE;
410 f.param_type = CPT_LIGHT;
411 f.light_propagates = true;
412 f.sunlight_propagates = true;
416 f.buildable_to = true;
417 // Insert directly into containers
418 content_t c = CONTENT_AIR;
419 m_content_features[c] = f;
420 addNameIdMapping(c, f.name);
422 // Set CONTENT_IGNORE
426 f.drawtype = NDT_AIRLIKE;
427 f.param_type = CPT_NONE;
428 f.light_propagates = false;
429 f.sunlight_propagates = false;
433 // A way to remove accidental CONTENT_IGNOREs
434 f.buildable_to = true;
435 // Insert directly into containers
436 content_t c = CONTENT_IGNORE;
437 m_content_features[c] = f;
438 addNameIdMapping(c, f.name);
441 // CONTENT_IGNORE = not found
442 content_t getFreeId()
444 for(u32 i=0; i<=0xffff; i++){
445 const ContentFeatures &f = m_content_features[i];
449 return CONTENT_IGNORE;
455 virtual ~CNodeDefManager()
458 virtual IWritableNodeDefManager* clone()
460 CNodeDefManager *mgr = new CNodeDefManager();
461 for(u16 i=0; i<=MAX_CONTENT; i++)
467 virtual const ContentFeatures& get(content_t c) const
469 assert(c <= MAX_CONTENT);
470 return m_content_features[c];
472 virtual const ContentFeatures& get(const MapNode &n) const
474 return get(n.getContent());
476 virtual bool getId(const std::string &name, content_t &result) const
478 std::map<std::string, content_t>::const_iterator
479 i = m_name_id_mapping_with_aliases.find(name);
480 if(i == m_name_id_mapping_with_aliases.end())
485 virtual content_t getId(const std::string &name) const
487 content_t id = CONTENT_IGNORE;
491 virtual void getIds(const std::string &name, std::set<content_t> &result)
494 if(name.substr(0,6) != "group:"){
495 content_t id = CONTENT_IGNORE;
500 std::string group = name.substr(6);
501 for(u16 id=0; id<=MAX_CONTENT; id++)
503 const ContentFeatures &f = m_content_features[id];
504 if(f.name == "") // Quickly discard undefined nodes
506 if(itemgroup_get(f.groups, group) != 0)
510 virtual const ContentFeatures& get(const std::string &name) const
512 content_t id = CONTENT_IGNORE;
516 // IWritableNodeDefManager
517 virtual void set(content_t c, const ContentFeatures &def)
519 verbosestream<<"registerNode: registering content id \""<<c
520 <<"\": name=\""<<def.name<<"\""<<std::endl;
521 assert(c <= MAX_CONTENT);
522 // Don't allow redefining CONTENT_IGNORE (but allow air)
523 if(def.name == "ignore" || c == CONTENT_IGNORE){
524 infostream<<"registerNode: WARNING: Ignoring "
525 <<"CONTENT_IGNORE redefinition"<<std::endl;
528 // Check that the special contents are not redefined as different id
529 // because it would mess up everything
530 if((def.name == "ignore" && c != CONTENT_IGNORE) ||
531 (def.name == "air" && c != CONTENT_AIR)){
532 errorstream<<"registerNode: IGNORING ERROR: "
533 <<"trying to register built-in type \""
534 <<def.name<<"\" as different id"<<std::endl;
537 m_content_features[c] = def;
539 addNameIdMapping(c, def.name);
541 virtual content_t set(const std::string &name,
542 const ContentFeatures &def)
544 assert(name == def.name);
545 u16 id = CONTENT_IGNORE;
546 bool found = m_name_id_mapping.getId(name, id); // ignore aliases
550 if(id == CONTENT_IGNORE)
551 return CONTENT_IGNORE;
553 addNameIdMapping(id, name);
558 virtual content_t allocateDummy(const std::string &name)
565 virtual void updateAliases(IItemDefManager *idef)
567 std::set<std::string> all = idef->getAll();
568 m_name_id_mapping_with_aliases.clear();
569 for(std::set<std::string>::iterator
570 i = all.begin(); i != all.end(); i++)
572 std::string name = *i;
573 std::string convert_to = idef->getAlias(name);
575 if(m_name_id_mapping.getId(convert_to, id))
577 m_name_id_mapping_with_aliases.insert(
578 std::make_pair(name, id));
582 virtual void updateTextures(ITextureSource *tsrc)
585 infostream<<"CNodeDefManager::updateTextures(): Updating "
586 <<"textures in node definitions"<<std::endl;
588 bool new_style_water = g_settings->getBool("new_style_water");
589 bool new_style_leaves = g_settings->getBool("new_style_leaves");
590 bool opaque_water = g_settings->getBool("opaque_water");
592 for(u16 i=0; i<=MAX_CONTENT; i++)
594 ContentFeatures *f = &m_content_features[i];
596 // Figure out the actual tiles to use
598 for(u32 j=0; j<6; j++)
600 tiledef[j] = f->tiledef[j];
601 if(tiledef[j].name == "")
602 tiledef[j].name = "unknown_block.png";
614 assert(f->liquid_type == LIQUID_SOURCE);
621 f->backface_culling = false;
624 case NDT_FLOWINGLIQUID:
625 assert(f->liquid_type == LIQUID_FLOWING);
632 f->visual_solidness = 1;
636 f->visual_solidness = 1;
638 case NDT_ALLFACES_OPTIONAL:
639 if(new_style_leaves){
640 f->drawtype = NDT_ALLFACES;
642 f->visual_solidness = 1;
644 f->drawtype = NDT_NORMAL;
646 for(u32 i=0; i<6; i++){
647 tiledef[i].name += std::string("^[noalpha");
661 // Tiles (fill in f->tiles[])
662 for(u16 j=0; j<6; j++){
664 f->tiles[j].texture = tsrc->getTexture(tiledef[j].name);
666 f->tiles[j].alpha = f->alpha;
668 f->tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
670 f->tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
672 f->tiles[j].material_flags = 0;
673 if(f->backface_culling)
674 f->tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
675 if(tiledef[j].animation.type == TAT_VERTICAL_FRAMES)
676 f->tiles[j].material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
677 // Animation parameters
678 if(f->tiles[j].material_flags &
679 MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES)
681 // Get raw texture size to determine frame count by
683 video::ITexture *t = tsrc->getTextureRaw(tiledef[j].name);
684 v2u32 size = t->getOriginalSize();
685 int frame_height = (float)size.X /
686 (float)tiledef[j].animation.aspect_w *
687 (float)tiledef[j].animation.aspect_h;
688 int frame_count = size.Y / frame_height;
689 int frame_length_ms = 1000.0 *
690 tiledef[j].animation.length / frame_count;
691 f->tiles[j].animation_frame_count = frame_count;
692 f->tiles[j].animation_frame_length_ms = frame_length_ms;
694 // If there are no frames for an animation, switch
695 // animation off (so that having specified an animation
696 // for something but not using it in the texture pack
697 // gives no overhead)
698 if(frame_count == 1){
699 f->tiles[j].material_flags &=
700 ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
704 // Special tiles (fill in f->special_tiles[])
705 for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
707 f->special_tiles[j].texture =
708 tsrc->getTexture(f->tiledef_special[j].name);
710 f->special_tiles[j].alpha = f->alpha;
712 f->special_tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
714 f->special_tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
716 f->special_tiles[j].material_flags = 0;
717 if(f->tiledef_special[j].backface_culling)
718 f->special_tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
719 if(f->tiledef_special[j].animation.type == TAT_VERTICAL_FRAMES)
720 f->special_tiles[j].material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
721 // Animation parameters
722 if(f->special_tiles[j].material_flags &
723 MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES)
725 // Get raw texture size to determine frame count by
727 video::ITexture *t = tsrc->getTextureRaw(f->tiledef_special[j].name);
728 v2u32 size = t->getOriginalSize();
729 int frame_height = (float)size.X /
730 (float)f->tiledef_special[j].animation.aspect_w *
731 (float)f->tiledef_special[j].animation.aspect_h;
732 int frame_count = size.Y / frame_height;
733 int frame_length_ms = 1000.0 *
734 f->tiledef_special[j].animation.length / frame_count;
735 f->special_tiles[j].animation_frame_count = frame_count;
736 f->special_tiles[j].animation_frame_length_ms = frame_length_ms;
738 // If there are no frames for an animation, switch
739 // animation off (so that having specified an animation
740 // for something but not using it in the texture pack
741 // gives no overhead)
742 if(frame_count == 1){
743 f->special_tiles[j].material_flags &=
744 ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
751 void serialize(std::ostream &os)
753 writeU8(os, 1); // version
755 std::ostringstream os2(std::ios::binary);
756 for(u16 i=0; i<=MAX_CONTENT; i++)
758 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
760 ContentFeatures *f = &m_content_features[i];
764 // Wrap it in a string to allow different lengths without
765 // strict version incompatibilities
766 std::ostringstream wrapper_os(std::ios::binary);
767 f->serialize(wrapper_os);
768 os2<<serializeString(wrapper_os.str());
772 os<<serializeLongString(os2.str());
774 void deSerialize(std::istream &is)
777 int version = readU8(is);
779 throw SerializationError("unsupported NodeDefinitionManager version");
780 u16 count = readU16(is);
781 std::istringstream is2(deSerializeLongString(is), std::ios::binary);
782 for(u16 n=0; n<count; n++){
783 u16 i = readU16(is2);
785 errorstream<<"ContentFeatures::deSerialize(): "
786 <<"Too large content id: "<<i<<std::endl;
789 /*// Do not deserialize special types
790 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
792 ContentFeatures *f = &m_content_features[i];
793 // Read it from the string wrapper
794 std::string wrapper = deSerializeString(is2);
795 std::istringstream wrapper_is(wrapper, std::ios::binary);
796 f->deSerialize(wrapper_is);
797 verbosestream<<"deserialized "<<f->name<<std::endl;
799 addNameIdMapping(i, f->name);
803 void addNameIdMapping(content_t i, std::string name)
805 m_name_id_mapping.set(i, name);
806 m_name_id_mapping_with_aliases.insert(std::make_pair(name, i));
809 // Features indexed by id
810 ContentFeatures m_content_features[MAX_CONTENT+1];
811 // A mapping for fast converting back and forth between names and ids
812 NameIdMapping m_name_id_mapping;
813 // Like m_name_id_mapping, but only from names to ids, and includes
814 // item aliases too. Updated by updateAliases()
815 // Note: Not serialized.
816 std::map<std::string, content_t> m_name_id_mapping_with_aliases;
819 IWritableNodeDefManager* createNodeDefManager()
821 return new CNodeDefManager();