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, 5); // 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
269 writeU8(os, liquid_renewable);
272 void ContentFeatures::deSerialize(std::istream &is)
274 int version = readU8(is);
276 throw SerializationError("unsupported ContentFeatures version");
277 name = deSerializeString(is);
279 u32 groups_size = readU16(is);
280 for(u32 i=0; i<groups_size; i++){
281 std::string name = deSerializeString(is);
282 int value = readS16(is);
283 groups[name] = value;
285 drawtype = (enum NodeDrawType)readU8(is);
286 visual_scale = readF1000(is);
288 throw SerializationError("unsupported tile count");
289 for(u32 i=0; i<6; i++)
290 tiledef[i].deSerialize(is);
291 if(readU8(is) != CF_SPECIAL_COUNT)
292 throw SerializationError("unsupported CF_SPECIAL_COUNT");
293 for(u32 i=0; i<CF_SPECIAL_COUNT; i++)
294 tiledef_special[i].deSerialize(is);
296 post_effect_color.setAlpha(readU8(is));
297 post_effect_color.setRed(readU8(is));
298 post_effect_color.setGreen(readU8(is));
299 post_effect_color.setBlue(readU8(is));
300 param_type = (enum ContentParamType)readU8(is);
301 param_type_2 = (enum ContentParamType2)readU8(is);
302 is_ground_content = readU8(is);
303 light_propagates = readU8(is);
304 sunlight_propagates = readU8(is);
305 walkable = readU8(is);
306 pointable = readU8(is);
307 diggable = readU8(is);
308 climbable = readU8(is);
309 buildable_to = readU8(is);
310 deSerializeString(is); // legacy: used to be metadata_name
311 liquid_type = (enum LiquidType)readU8(is);
312 liquid_alternative_flowing = deSerializeString(is);
313 liquid_alternative_source = deSerializeString(is);
314 liquid_viscosity = readU8(is);
315 liquid_renewable = readU8(is);
316 light_source = readU8(is);
317 damage_per_second = readU32(is);
318 node_box.deSerialize(is);
319 selection_box.deSerialize(is);
320 legacy_facedir_simple = readU8(is);
321 legacy_wallmounted = readU8(is);
322 deSerializeSimpleSoundSpec(sound_footstep, is);
323 deSerializeSimpleSoundSpec(sound_dig, is);
324 deSerializeSimpleSoundSpec(sound_dug, is);
325 // If you add anything here, insert it primarily inside the try-catch
326 // block to not need to increase the version.
328 // Stuff below should be moved to correct place in a version that
329 // otherwise changes the protocol version
330 liquid_renewable = readU8(is);
331 }catch(SerializationError &e) {};
338 class CNodeDefManager: public IWritableNodeDefManager
343 m_name_id_mapping.clear();
344 m_name_id_mapping_with_aliases.clear();
346 for(u16 i=0; i<=MAX_CONTENT; i++)
348 ContentFeatures &f = m_content_features[i];
349 f.reset(); // Reset to defaults
356 f.drawtype = NDT_AIRLIKE;
357 f.param_type = CPT_LIGHT;
358 f.light_propagates = true;
359 f.sunlight_propagates = true;
363 f.buildable_to = true;
364 // Insert directly into containers
365 content_t c = CONTENT_AIR;
366 m_content_features[c] = f;
367 addNameIdMapping(c, f.name);
369 // Set CONTENT_IGNORE
373 f.drawtype = NDT_AIRLIKE;
374 f.param_type = CPT_NONE;
375 f.light_propagates = false;
376 f.sunlight_propagates = false;
380 // A way to remove accidental CONTENT_IGNOREs
381 f.buildable_to = true;
382 // Insert directly into containers
383 content_t c = CONTENT_IGNORE;
384 m_content_features[c] = f;
385 addNameIdMapping(c, f.name);
388 // CONTENT_IGNORE = not found
389 content_t getFreeId()
391 for(u32 i=0; i<=0xffff; i++){
392 const ContentFeatures &f = m_content_features[i];
396 return CONTENT_IGNORE;
402 virtual ~CNodeDefManager()
405 virtual IWritableNodeDefManager* clone()
407 CNodeDefManager *mgr = new CNodeDefManager();
408 for(u16 i=0; i<=MAX_CONTENT; i++)
414 virtual const ContentFeatures& get(content_t c) const
416 assert(c <= MAX_CONTENT);
417 return m_content_features[c];
419 virtual const ContentFeatures& get(const MapNode &n) const
421 return get(n.getContent());
423 virtual bool getId(const std::string &name, content_t &result) const
425 std::map<std::string, content_t>::const_iterator
426 i = m_name_id_mapping_with_aliases.find(name);
427 if(i == m_name_id_mapping_with_aliases.end())
432 virtual content_t getId(const std::string &name) const
434 content_t id = CONTENT_IGNORE;
438 virtual void getIds(const std::string &name, std::set<content_t> &result)
441 if(name.substr(0,6) != "group:"){
442 content_t id = CONTENT_IGNORE;
447 std::string group = name.substr(6);
448 for(u16 id=0; id<=MAX_CONTENT; id++)
450 const ContentFeatures &f = m_content_features[id];
451 if(f.name == "") // Quickly discard undefined nodes
453 if(itemgroup_get(f.groups, group) != 0)
457 virtual const ContentFeatures& get(const std::string &name) const
459 content_t id = CONTENT_IGNORE;
463 // IWritableNodeDefManager
464 virtual void set(content_t c, const ContentFeatures &def)
466 verbosestream<<"registerNode: registering content id \""<<c
467 <<"\": name=\""<<def.name<<"\""<<std::endl;
468 assert(c <= MAX_CONTENT);
469 // Don't allow redefining CONTENT_IGNORE (but allow air)
470 if(def.name == "ignore" || c == CONTENT_IGNORE){
471 infostream<<"registerNode: WARNING: Ignoring "
472 <<"CONTENT_IGNORE redefinition"<<std::endl;
475 // Check that the special contents are not redefined as different id
476 // because it would mess up everything
477 if((def.name == "ignore" && c != CONTENT_IGNORE) ||
478 (def.name == "air" && c != CONTENT_AIR)){
479 errorstream<<"registerNode: IGNORING ERROR: "
480 <<"trying to register built-in type \""
481 <<def.name<<"\" as different id"<<std::endl;
484 m_content_features[c] = def;
486 addNameIdMapping(c, def.name);
488 virtual content_t set(const std::string &name,
489 const ContentFeatures &def)
491 assert(name == def.name);
492 u16 id = CONTENT_IGNORE;
493 bool found = m_name_id_mapping.getId(name, id); // ignore aliases
497 if(id == CONTENT_IGNORE)
498 return CONTENT_IGNORE;
500 addNameIdMapping(id, name);
505 virtual content_t allocateDummy(const std::string &name)
512 virtual void updateAliases(IItemDefManager *idef)
514 std::set<std::string> all = idef->getAll();
515 m_name_id_mapping_with_aliases.clear();
516 for(std::set<std::string>::iterator
517 i = all.begin(); i != all.end(); i++)
519 std::string name = *i;
520 std::string convert_to = idef->getAlias(name);
522 if(m_name_id_mapping.getId(convert_to, id))
524 m_name_id_mapping_with_aliases.insert(
525 std::make_pair(name, id));
529 virtual void updateTextures(ITextureSource *tsrc)
532 infostream<<"CNodeDefManager::updateTextures(): Updating "
533 <<"textures in node definitions"<<std::endl;
535 bool new_style_water = g_settings->getBool("new_style_water");
536 bool new_style_leaves = g_settings->getBool("new_style_leaves");
537 bool opaque_water = g_settings->getBool("opaque_water");
539 for(u16 i=0; i<=MAX_CONTENT; i++)
541 ContentFeatures *f = &m_content_features[i];
543 // Figure out the actual tiles to use
545 for(u32 j=0; j<6; j++)
547 tiledef[j] = f->tiledef[j];
548 if(tiledef[j].name == "")
549 tiledef[j].name = "unknown_block.png";
561 assert(f->liquid_type == LIQUID_SOURCE);
568 f->backface_culling = false;
571 case NDT_FLOWINGLIQUID:
572 assert(f->liquid_type == LIQUID_FLOWING);
579 f->visual_solidness = 1;
583 f->visual_solidness = 1;
585 case NDT_ALLFACES_OPTIONAL:
586 if(new_style_leaves){
587 f->drawtype = NDT_ALLFACES;
589 f->visual_solidness = 1;
591 f->drawtype = NDT_NORMAL;
593 for(u32 i=0; i<6; i++){
594 tiledef[i].name += std::string("^[noalpha");
608 // Tiles (fill in f->tiles[])
609 for(u16 j=0; j<6; j++){
611 f->tiles[j].texture = tsrc->getTexture(tiledef[j].name);
613 f->tiles[j].alpha = f->alpha;
615 f->tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
617 f->tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
619 f->tiles[j].material_flags = 0;
620 if(f->backface_culling)
621 f->tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
622 if(tiledef[j].animation.type == TAT_VERTICAL_FRAMES)
623 f->tiles[j].material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
624 // Animation parameters
625 if(f->tiles[j].material_flags &
626 MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES)
628 // Get raw texture size to determine frame count by
630 video::ITexture *t = tsrc->getTextureRaw(tiledef[j].name);
631 v2u32 size = t->getOriginalSize();
632 int frame_height = (float)size.X /
633 (float)tiledef[j].animation.aspect_w *
634 (float)tiledef[j].animation.aspect_h;
635 int frame_count = size.Y / frame_height;
636 int frame_length_ms = 1000.0 *
637 tiledef[j].animation.length / frame_count;
638 f->tiles[j].animation_frame_count = frame_count;
639 f->tiles[j].animation_frame_length_ms = frame_length_ms;
641 // If there are no frames for an animation, switch
642 // animation off (so that having specified an animation
643 // for something but not using it in the texture pack
644 // gives no overhead)
645 if(frame_count == 1){
646 f->tiles[j].material_flags &=
647 ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
651 // Special tiles (fill in f->special_tiles[])
652 for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
654 f->special_tiles[j].texture =
655 tsrc->getTexture(f->tiledef_special[j].name);
657 f->special_tiles[j].alpha = f->alpha;
659 f->special_tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
661 f->special_tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
663 f->special_tiles[j].material_flags = 0;
664 if(f->tiledef_special[j].backface_culling)
665 f->special_tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
666 if(f->tiledef_special[j].animation.type == TAT_VERTICAL_FRAMES)
667 f->special_tiles[j].material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
668 // Animation parameters
669 if(f->special_tiles[j].material_flags &
670 MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES)
672 // Get raw texture size to determine frame count by
674 video::ITexture *t = tsrc->getTextureRaw(f->tiledef_special[j].name);
675 v2u32 size = t->getOriginalSize();
676 int frame_height = (float)size.X /
677 (float)f->tiledef_special[j].animation.aspect_w *
678 (float)f->tiledef_special[j].animation.aspect_h;
679 int frame_count = size.Y / frame_height;
680 int frame_length_ms = 1000.0 *
681 f->tiledef_special[j].animation.length / frame_count;
682 f->special_tiles[j].animation_frame_count = frame_count;
683 f->special_tiles[j].animation_frame_length_ms = frame_length_ms;
685 // If there are no frames for an animation, switch
686 // animation off (so that having specified an animation
687 // for something but not using it in the texture pack
688 // gives no overhead)
689 if(frame_count == 1){
690 f->special_tiles[j].material_flags &=
691 ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
698 void serialize(std::ostream &os)
700 writeU8(os, 1); // version
702 std::ostringstream os2(std::ios::binary);
703 for(u16 i=0; i<=MAX_CONTENT; i++)
705 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
707 ContentFeatures *f = &m_content_features[i];
711 // Wrap it in a string to allow different lengths without
712 // strict version incompatibilities
713 std::ostringstream wrapper_os(std::ios::binary);
714 f->serialize(wrapper_os);
715 os2<<serializeString(wrapper_os.str());
719 os<<serializeLongString(os2.str());
721 void deSerialize(std::istream &is)
724 int version = readU8(is);
726 throw SerializationError("unsupported NodeDefinitionManager version");
727 u16 count = readU16(is);
728 std::istringstream is2(deSerializeLongString(is), std::ios::binary);
729 for(u16 n=0; n<count; n++){
730 u16 i = readU16(is2);
732 errorstream<<"ContentFeatures::deSerialize(): "
733 <<"Too large content id: "<<i<<std::endl;
736 /*// Do not deserialize special types
737 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
739 ContentFeatures *f = &m_content_features[i];
740 // Read it from the string wrapper
741 std::string wrapper = deSerializeString(is2);
742 std::istringstream wrapper_is(wrapper, std::ios::binary);
743 f->deSerialize(wrapper_is);
744 verbosestream<<"deserialized "<<f->name<<std::endl;
746 addNameIdMapping(i, f->name);
750 void addNameIdMapping(content_t i, std::string name)
752 m_name_id_mapping.set(i, name);
753 m_name_id_mapping_with_aliases.insert(std::make_pair(name, i));
756 // Features indexed by id
757 ContentFeatures m_content_features[MAX_CONTENT+1];
758 // A mapping for fast converting back and forth between names and ids
759 NameIdMapping m_name_id_mapping;
760 // Like m_name_id_mapping, but only from names to ids, and includes
761 // item aliases too. Updated by updateAliases()
762 // Note: Not serialized.
763 std::map<std::string, content_t> m_name_id_mapping_with_aliases;
766 IWritableNodeDefManager* createNodeDefManager()
768 return new CNodeDefManager();