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;
207 damage_per_second = 0;
208 node_box = NodeBox();
209 selection_box = NodeBox();
210 legacy_facedir_simple = false;
211 legacy_wallmounted = false;
212 sound_footstep = SimpleSoundSpec();
213 sound_dig = SimpleSoundSpec("__group");
214 sound_dug = SimpleSoundSpec();
217 void ContentFeatures::serialize(std::ostream &os)
219 writeU8(os, 5); // version
220 os<<serializeString(name);
221 writeU16(os, groups.size());
222 for(ItemGroupList::const_iterator
223 i = groups.begin(); i != groups.end(); i++){
224 os<<serializeString(i->first);
225 writeS16(os, i->second);
227 writeU8(os, drawtype);
228 writeF1000(os, visual_scale);
230 for(u32 i=0; i<6; i++)
231 tiledef[i].serialize(os);
232 writeU8(os, CF_SPECIAL_COUNT);
233 for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
234 tiledef_special[i].serialize(os);
237 writeU8(os, post_effect_color.getAlpha());
238 writeU8(os, post_effect_color.getRed());
239 writeU8(os, post_effect_color.getGreen());
240 writeU8(os, post_effect_color.getBlue());
241 writeU8(os, param_type);
242 writeU8(os, param_type_2);
243 writeU8(os, is_ground_content);
244 writeU8(os, light_propagates);
245 writeU8(os, sunlight_propagates);
246 writeU8(os, walkable);
247 writeU8(os, pointable);
248 writeU8(os, diggable);
249 writeU8(os, climbable);
250 writeU8(os, buildable_to);
251 os<<serializeString(""); // legacy: used to be metadata_name
252 writeU8(os, liquid_type);
253 os<<serializeString(liquid_alternative_flowing);
254 os<<serializeString(liquid_alternative_source);
255 writeU8(os, liquid_viscosity);
256 writeU8(os, light_source);
257 writeU32(os, damage_per_second);
258 node_box.serialize(os);
259 selection_box.serialize(os);
260 writeU8(os, legacy_facedir_simple);
261 writeU8(os, legacy_wallmounted);
262 serializeSimpleSoundSpec(sound_footstep, os);
263 serializeSimpleSoundSpec(sound_dig, os);
264 serializeSimpleSoundSpec(sound_dug, os);
267 void ContentFeatures::deSerialize(std::istream &is)
269 int version = readU8(is);
271 throw SerializationError("unsupported ContentFeatures version");
272 name = deSerializeString(is);
274 u32 groups_size = readU16(is);
275 for(u32 i=0; i<groups_size; i++){
276 std::string name = deSerializeString(is);
277 int value = readS16(is);
278 groups[name] = value;
280 drawtype = (enum NodeDrawType)readU8(is);
281 visual_scale = readF1000(is);
283 throw SerializationError("unsupported tile count");
284 for(u32 i=0; i<6; i++)
285 tiledef[i].deSerialize(is);
286 if(readU8(is) != CF_SPECIAL_COUNT)
287 throw SerializationError("unsupported CF_SPECIAL_COUNT");
288 for(u32 i=0; i<CF_SPECIAL_COUNT; i++)
289 tiledef_special[i].deSerialize(is);
291 post_effect_color.setAlpha(readU8(is));
292 post_effect_color.setRed(readU8(is));
293 post_effect_color.setGreen(readU8(is));
294 post_effect_color.setBlue(readU8(is));
295 param_type = (enum ContentParamType)readU8(is);
296 param_type_2 = (enum ContentParamType2)readU8(is);
297 is_ground_content = readU8(is);
298 light_propagates = readU8(is);
299 sunlight_propagates = readU8(is);
300 walkable = readU8(is);
301 pointable = readU8(is);
302 diggable = readU8(is);
303 climbable = readU8(is);
304 buildable_to = readU8(is);
305 deSerializeString(is); // legacy: used to be metadata_name
306 liquid_type = (enum LiquidType)readU8(is);
307 liquid_alternative_flowing = deSerializeString(is);
308 liquid_alternative_source = deSerializeString(is);
309 liquid_viscosity = readU8(is);
310 light_source = readU8(is);
311 damage_per_second = readU32(is);
312 node_box.deSerialize(is);
313 selection_box.deSerialize(is);
314 legacy_facedir_simple = readU8(is);
315 legacy_wallmounted = readU8(is);
316 deSerializeSimpleSoundSpec(sound_footstep, is);
317 deSerializeSimpleSoundSpec(sound_dig, is);
318 deSerializeSimpleSoundSpec(sound_dug, is);
319 // If you add anything here, insert it primarily inside the try-catch
320 // block to not need to increase the version.
322 }catch(SerializationError &e) {};
329 class CNodeDefManager: public IWritableNodeDefManager
334 m_name_id_mapping.clear();
335 m_name_id_mapping_with_aliases.clear();
337 for(u16 i=0; i<=MAX_CONTENT; i++)
339 ContentFeatures &f = m_content_features[i];
340 f.reset(); // Reset to defaults
347 f.drawtype = NDT_AIRLIKE;
348 f.param_type = CPT_LIGHT;
349 f.light_propagates = true;
350 f.sunlight_propagates = true;
354 f.buildable_to = true;
355 // Insert directly into containers
356 content_t c = CONTENT_AIR;
357 m_content_features[c] = f;
358 addNameIdMapping(c, f.name);
360 // Set CONTENT_IGNORE
364 f.drawtype = NDT_AIRLIKE;
365 f.param_type = CPT_NONE;
366 f.light_propagates = false;
367 f.sunlight_propagates = false;
371 // A way to remove accidental CONTENT_IGNOREs
372 f.buildable_to = true;
373 // Insert directly into containers
374 content_t c = CONTENT_IGNORE;
375 m_content_features[c] = f;
376 addNameIdMapping(c, f.name);
379 // CONTENT_IGNORE = not found
380 content_t getFreeId()
382 for(u32 i=0; i<=0xffff; i++){
383 const ContentFeatures &f = m_content_features[i];
387 return CONTENT_IGNORE;
393 virtual ~CNodeDefManager()
396 virtual IWritableNodeDefManager* clone()
398 CNodeDefManager *mgr = new CNodeDefManager();
399 for(u16 i=0; i<=MAX_CONTENT; i++)
405 virtual const ContentFeatures& get(content_t c) const
407 assert(c <= MAX_CONTENT);
408 return m_content_features[c];
410 virtual const ContentFeatures& get(const MapNode &n) const
412 return get(n.getContent());
414 virtual bool getId(const std::string &name, content_t &result) const
416 std::map<std::string, content_t>::const_iterator
417 i = m_name_id_mapping_with_aliases.find(name);
418 if(i == m_name_id_mapping_with_aliases.end())
423 virtual content_t getId(const std::string &name) const
425 content_t id = CONTENT_IGNORE;
429 virtual void getIds(const std::string &name, std::set<content_t> &result)
432 if(name.substr(0,6) != "group:"){
433 content_t id = CONTENT_IGNORE;
438 std::string group = name.substr(6);
439 for(u16 id=0; id<=MAX_CONTENT; id++)
441 const ContentFeatures &f = m_content_features[id];
442 if(f.name == "") // Quickly discard undefined nodes
444 if(itemgroup_get(f.groups, group) != 0)
448 virtual const ContentFeatures& get(const std::string &name) const
450 content_t id = CONTENT_IGNORE;
454 // IWritableNodeDefManager
455 virtual void set(content_t c, const ContentFeatures &def)
457 verbosestream<<"registerNode: registering content id \""<<c
458 <<"\": name=\""<<def.name<<"\""<<std::endl;
459 assert(c <= MAX_CONTENT);
460 // Don't allow redefining CONTENT_IGNORE (but allow air)
461 if(def.name == "ignore" || c == CONTENT_IGNORE){
462 infostream<<"registerNode: WARNING: Ignoring "
463 <<"CONTENT_IGNORE redefinition"<<std::endl;
466 // Check that the special contents are not redefined as different id
467 // because it would mess up everything
468 if((def.name == "ignore" && c != CONTENT_IGNORE) ||
469 (def.name == "air" && c != CONTENT_AIR)){
470 errorstream<<"registerNode: IGNORING ERROR: "
471 <<"trying to register built-in type \""
472 <<def.name<<"\" as different id"<<std::endl;
475 m_content_features[c] = def;
477 addNameIdMapping(c, def.name);
479 virtual content_t set(const std::string &name,
480 const ContentFeatures &def)
482 assert(name == def.name);
483 u16 id = CONTENT_IGNORE;
484 bool found = m_name_id_mapping.getId(name, id); // ignore aliases
488 if(id == CONTENT_IGNORE)
489 return CONTENT_IGNORE;
491 addNameIdMapping(id, name);
496 virtual content_t allocateDummy(const std::string &name)
503 virtual void updateAliases(IItemDefManager *idef)
505 std::set<std::string> all = idef->getAll();
506 m_name_id_mapping_with_aliases.clear();
507 for(std::set<std::string>::iterator
508 i = all.begin(); i != all.end(); i++)
510 std::string name = *i;
511 std::string convert_to = idef->getAlias(name);
513 if(m_name_id_mapping.getId(convert_to, id))
515 m_name_id_mapping_with_aliases.insert(
516 std::make_pair(name, id));
520 virtual void updateTextures(ITextureSource *tsrc)
523 infostream<<"CNodeDefManager::updateTextures(): Updating "
524 <<"textures in node definitions"<<std::endl;
526 bool new_style_water = g_settings->getBool("new_style_water");
527 bool new_style_leaves = g_settings->getBool("new_style_leaves");
528 bool opaque_water = g_settings->getBool("opaque_water");
530 for(u16 i=0; i<=MAX_CONTENT; i++)
532 ContentFeatures *f = &m_content_features[i];
534 // Figure out the actual tiles to use
536 for(u32 j=0; j<6; j++)
538 tiledef[j] = f->tiledef[j];
539 if(tiledef[j].name == "")
540 tiledef[j].name = "unknown_block.png";
552 assert(f->liquid_type == LIQUID_SOURCE);
559 f->backface_culling = false;
562 case NDT_FLOWINGLIQUID:
563 assert(f->liquid_type == LIQUID_FLOWING);
570 f->visual_solidness = 1;
574 f->visual_solidness = 1;
576 case NDT_ALLFACES_OPTIONAL:
577 if(new_style_leaves){
578 f->drawtype = NDT_ALLFACES;
580 f->visual_solidness = 1;
582 f->drawtype = NDT_NORMAL;
584 for(u32 i=0; i<6; i++){
585 tiledef[i].name += std::string("^[noalpha");
599 // Tiles (fill in f->tiles[])
600 for(u16 j=0; j<6; j++){
602 f->tiles[j].texture = tsrc->getTexture(tiledef[j].name);
604 f->tiles[j].alpha = f->alpha;
606 f->tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
608 f->tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
610 f->tiles[j].material_flags = 0;
611 if(f->backface_culling)
612 f->tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
613 if(tiledef[j].animation.type == TAT_VERTICAL_FRAMES)
614 f->tiles[j].material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
615 // Animation parameters
616 if(f->tiles[j].material_flags &
617 MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES)
619 // Get raw texture size to determine frame count by
621 video::ITexture *t = tsrc->getTextureRaw(tiledef[j].name);
622 v2u32 size = t->getOriginalSize();
623 int frame_height = (float)size.X /
624 (float)tiledef[j].animation.aspect_w *
625 (float)tiledef[j].animation.aspect_h;
626 int frame_count = size.Y / frame_height;
627 int frame_length_ms = 1000.0 *
628 tiledef[j].animation.length / frame_count;
629 f->tiles[j].animation_frame_count = frame_count;
630 f->tiles[j].animation_frame_length_ms = frame_length_ms;
632 // If there are no frames for an animation, switch
633 // animation off (so that having specified an animation
634 // for something but not using it in the texture pack
635 // gives no overhead)
636 if(frame_count == 1){
637 f->tiles[j].material_flags &=
638 ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
642 // Special tiles (fill in f->special_tiles[])
643 for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
645 f->special_tiles[j].texture =
646 tsrc->getTexture(f->tiledef_special[j].name);
648 f->special_tiles[j].alpha = f->alpha;
650 f->special_tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
652 f->special_tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
654 f->special_tiles[j].material_flags = 0;
655 if(f->tiledef_special[j].backface_culling)
656 f->special_tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
657 if(f->tiledef_special[j].animation.type == TAT_VERTICAL_FRAMES)
658 f->special_tiles[j].material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
659 // Animation parameters
660 if(f->special_tiles[j].material_flags &
661 MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES)
663 // Get raw texture size to determine frame count by
665 video::ITexture *t = tsrc->getTextureRaw(f->tiledef_special[j].name);
666 v2u32 size = t->getOriginalSize();
667 int frame_height = (float)size.X /
668 (float)f->tiledef_special[j].animation.aspect_w *
669 (float)f->tiledef_special[j].animation.aspect_h;
670 int frame_count = size.Y / frame_height;
671 int frame_length_ms = 1000.0 *
672 f->tiledef_special[j].animation.length / frame_count;
673 f->special_tiles[j].animation_frame_count = frame_count;
674 f->special_tiles[j].animation_frame_length_ms = frame_length_ms;
676 // If there are no frames for an animation, switch
677 // animation off (so that having specified an animation
678 // for something but not using it in the texture pack
679 // gives no overhead)
680 if(frame_count == 1){
681 f->special_tiles[j].material_flags &=
682 ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
689 void serialize(std::ostream &os)
691 writeU8(os, 1); // version
693 std::ostringstream os2(std::ios::binary);
694 for(u16 i=0; i<=MAX_CONTENT; i++)
696 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
698 ContentFeatures *f = &m_content_features[i];
702 // Wrap it in a string to allow different lengths without
703 // strict version incompatibilities
704 std::ostringstream wrapper_os(std::ios::binary);
705 f->serialize(wrapper_os);
706 os2<<serializeString(wrapper_os.str());
710 os<<serializeLongString(os2.str());
712 void deSerialize(std::istream &is)
715 int version = readU8(is);
717 throw SerializationError("unsupported NodeDefinitionManager version");
718 u16 count = readU16(is);
719 std::istringstream is2(deSerializeLongString(is), std::ios::binary);
720 for(u16 n=0; n<count; n++){
721 u16 i = readU16(is2);
723 errorstream<<"ContentFeatures::deSerialize(): "
724 <<"Too large content id: "<<i<<std::endl;
727 /*// Do not deserialize special types
728 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
730 ContentFeatures *f = &m_content_features[i];
731 // Read it from the string wrapper
732 std::string wrapper = deSerializeString(is2);
733 std::istringstream wrapper_is(wrapper, std::ios::binary);
734 f->deSerialize(wrapper_is);
735 verbosestream<<"deserialized "<<f->name<<std::endl;
737 addNameIdMapping(i, f->name);
741 void addNameIdMapping(content_t i, std::string name)
743 m_name_id_mapping.set(i, name);
744 m_name_id_mapping_with_aliases.insert(std::make_pair(name, i));
747 // Features indexed by id
748 ContentFeatures m_content_features[MAX_CONTENT+1];
749 // A mapping for fast converting back and forth between names and ids
750 NameIdMapping m_name_id_mapping;
751 // Like m_name_id_mapping, but only from names to ids, and includes
752 // item aliases too. Updated by updateAliases()
753 // Note: Not serialized.
754 std::map<std::string, content_t> m_name_id_mapping_with_aliases;
757 IWritableNodeDefManager* createNodeDefManager()
759 return new CNodeDefManager();