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"
35 void NodeBox::serialize(std::ostream &os) const
37 writeU8(os, 0); // version
39 writeV3F1000(os, fixed.MinEdge);
40 writeV3F1000(os, fixed.MaxEdge);
41 writeV3F1000(os, wall_top.MinEdge);
42 writeV3F1000(os, wall_top.MaxEdge);
43 writeV3F1000(os, wall_bottom.MinEdge);
44 writeV3F1000(os, wall_bottom.MaxEdge);
45 writeV3F1000(os, wall_side.MinEdge);
46 writeV3F1000(os, wall_side.MaxEdge);
49 void NodeBox::deSerialize(std::istream &is)
51 int version = readU8(is);
53 throw SerializationError("unsupported NodeBox version");
54 type = (enum NodeBoxType)readU8(is);
55 fixed.MinEdge = readV3F1000(is);
56 fixed.MaxEdge = readV3F1000(is);
57 wall_top.MinEdge = readV3F1000(is);
58 wall_top.MaxEdge = readV3F1000(is);
59 wall_bottom.MinEdge = readV3F1000(is);
60 wall_bottom.MaxEdge = readV3F1000(is);
61 wall_side.MinEdge = readV3F1000(is);
62 wall_side.MaxEdge = readV3F1000(is);
69 void MaterialSpec::serialize(std::ostream &os) const
71 os<<serializeString(tname);
72 writeU8(os, backface_culling);
75 void MaterialSpec::deSerialize(std::istream &is)
77 tname = deSerializeString(is);
78 backface_culling = readU8(is);
82 SimpleSoundSpec serialization
85 static void serializeSimpleSoundSpec(const SimpleSoundSpec &ss,
88 os<<serializeString(ss.name);
89 writeF1000(os, ss.gain);
91 static void deSerializeSimpleSoundSpec(SimpleSoundSpec &ss, std::istream &is)
93 ss.name = deSerializeString(is);
94 ss.gain = readF1000(is);
101 ContentFeatures::ContentFeatures()
106 ContentFeatures::~ContentFeatures()
110 void ContentFeatures::reset()
117 visual_solidness = 0;
118 backface_culling = true;
120 has_on_construct = false;
121 has_on_destruct = false;
122 has_after_destruct = false;
126 NOTE: Most of this is always overridden by the default values given
131 // Unknown nodes can be dug
132 groups["dig_immediate"] = 2;
133 drawtype = NDT_NORMAL;
135 for(u32 i=0; i<6; i++)
137 for(u16 j=0; j<CF_SPECIAL_COUNT; j++)
138 mspec_special[j] = MaterialSpec();
140 post_effect_color = video::SColor(0, 0, 0, 0);
141 param_type = CPT_NONE;
142 param_type_2 = CPT2_NONE;
143 is_ground_content = false;
144 light_propagates = false;
145 sunlight_propagates = false;
150 buildable_to = false;
151 liquid_type = LIQUID_NONE;
152 liquid_alternative_flowing = "";
153 liquid_alternative_source = "";
154 liquid_viscosity = 0;
156 damage_per_second = 0;
157 selection_box = NodeBox();
158 legacy_facedir_simple = false;
159 legacy_wallmounted = false;
160 sound_footstep = SimpleSoundSpec();
161 sound_dig = SimpleSoundSpec("__group");
162 sound_dug = SimpleSoundSpec();
165 void ContentFeatures::serialize(std::ostream &os)
167 writeU8(os, 3); // version
168 os<<serializeString(name);
169 writeU16(os, groups.size());
170 for(ItemGroupList::const_iterator
171 i = groups.begin(); i != groups.end(); i++){
172 os<<serializeString(i->first);
173 writeS16(os, i->second);
175 writeU8(os, drawtype);
176 writeF1000(os, visual_scale);
178 for(u32 i=0; i<6; i++)
179 os<<serializeString(tname_tiles[i]);
180 writeU8(os, CF_SPECIAL_COUNT);
181 for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
182 mspec_special[i].serialize(os);
185 writeU8(os, post_effect_color.getAlpha());
186 writeU8(os, post_effect_color.getRed());
187 writeU8(os, post_effect_color.getGreen());
188 writeU8(os, post_effect_color.getBlue());
189 writeU8(os, param_type);
190 writeU8(os, param_type_2);
191 writeU8(os, is_ground_content);
192 writeU8(os, light_propagates);
193 writeU8(os, sunlight_propagates);
194 writeU8(os, walkable);
195 writeU8(os, pointable);
196 writeU8(os, diggable);
197 writeU8(os, climbable);
198 writeU8(os, buildable_to);
199 os<<serializeString(""); // legacy: used to be metadata_name
200 writeU8(os, liquid_type);
201 os<<serializeString(liquid_alternative_flowing);
202 os<<serializeString(liquid_alternative_source);
203 writeU8(os, liquid_viscosity);
204 writeU8(os, light_source);
205 writeU32(os, damage_per_second);
206 selection_box.serialize(os);
207 writeU8(os, legacy_facedir_simple);
208 writeU8(os, legacy_wallmounted);
209 serializeSimpleSoundSpec(sound_footstep, os);
210 serializeSimpleSoundSpec(sound_dig, os);
211 serializeSimpleSoundSpec(sound_dug, os);
214 void ContentFeatures::deSerialize(std::istream &is)
216 int version = readU8(is);
218 throw SerializationError("unsupported ContentFeatures version");
219 name = deSerializeString(is);
221 u32 groups_size = readU16(is);
222 for(u32 i=0; i<groups_size; i++){
223 std::string name = deSerializeString(is);
224 int value = readS16(is);
225 groups[name] = value;
227 drawtype = (enum NodeDrawType)readU8(is);
228 visual_scale = readF1000(is);
230 throw SerializationError("unsupported tile count");
231 for(u32 i=0; i<6; i++)
232 tname_tiles[i] = deSerializeString(is);
233 if(readU8(is) != CF_SPECIAL_COUNT)
234 throw SerializationError("unsupported CF_SPECIAL_COUNT");
235 for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
236 mspec_special[i].deSerialize(is);
239 post_effect_color.setAlpha(readU8(is));
240 post_effect_color.setRed(readU8(is));
241 post_effect_color.setGreen(readU8(is));
242 post_effect_color.setBlue(readU8(is));
243 param_type = (enum ContentParamType)readU8(is);
244 param_type_2 = (enum ContentParamType2)readU8(is);
245 is_ground_content = readU8(is);
246 light_propagates = readU8(is);
247 sunlight_propagates = readU8(is);
248 walkable = readU8(is);
249 pointable = readU8(is);
250 diggable = readU8(is);
251 climbable = readU8(is);
252 buildable_to = readU8(is);
253 deSerializeString(is); // legacy: used to be metadata_name
254 liquid_type = (enum LiquidType)readU8(is);
255 liquid_alternative_flowing = deSerializeString(is);
256 liquid_alternative_source = deSerializeString(is);
257 liquid_viscosity = readU8(is);
258 light_source = readU8(is);
259 damage_per_second = readU32(is);
260 selection_box.deSerialize(is);
261 legacy_facedir_simple = readU8(is);
262 legacy_wallmounted = readU8(is);
263 // If you add anything here, insert it primarily inside the try-catch
264 // block to not need to increase the version.
266 deSerializeSimpleSoundSpec(sound_footstep, is);
267 deSerializeSimpleSoundSpec(sound_dig, is);
268 deSerializeSimpleSoundSpec(sound_dug, is);
269 }catch(SerializationError &e) {};
276 class CNodeDefManager: public IWritableNodeDefManager
281 m_name_id_mapping.clear();
282 m_name_id_mapping_with_aliases.clear();
284 for(u16 i=0; i<=MAX_CONTENT; i++)
286 ContentFeatures &f = m_content_features[i];
287 f.reset(); // Reset to defaults
294 f.drawtype = NDT_AIRLIKE;
295 f.param_type = CPT_LIGHT;
296 f.light_propagates = true;
297 f.sunlight_propagates = true;
301 f.buildable_to = true;
302 // Insert directly into containers
303 content_t c = CONTENT_AIR;
304 m_content_features[c] = f;
305 addNameIdMapping(c, f.name);
307 // Set CONTENT_IGNORE
311 f.drawtype = NDT_AIRLIKE;
312 f.param_type = CPT_NONE;
313 f.light_propagates = false;
314 f.sunlight_propagates = false;
318 // A way to remove accidental CONTENT_IGNOREs
319 f.buildable_to = true;
320 // Insert directly into containers
321 content_t c = CONTENT_IGNORE;
322 m_content_features[c] = f;
323 addNameIdMapping(c, f.name);
326 // CONTENT_IGNORE = not found
327 content_t getFreeId(bool require_full_param2)
329 // If allowed, first search in the large 4-bit-param2 pool
330 if(!require_full_param2){
331 for(u16 i=0x800; i<=0xfff; i++){
332 const ContentFeatures &f = m_content_features[i];
337 // Then search from the small 8-bit-param2 pool
338 for(u16 i=0; i<=125; i++){
339 const ContentFeatures &f = m_content_features[i];
343 return CONTENT_IGNORE;
349 virtual ~CNodeDefManager()
352 virtual IWritableNodeDefManager* clone()
354 CNodeDefManager *mgr = new CNodeDefManager();
355 for(u16 i=0; i<=MAX_CONTENT; i++)
361 virtual const ContentFeatures& get(content_t c) const
363 assert(c <= MAX_CONTENT);
364 return m_content_features[c];
366 virtual const ContentFeatures& get(const MapNode &n) const
368 return get(n.getContent());
370 virtual bool getId(const std::string &name, content_t &result) const
372 std::map<std::string, content_t>::const_iterator
373 i = m_name_id_mapping_with_aliases.find(name);
374 if(i == m_name_id_mapping_with_aliases.end())
379 virtual content_t getId(const std::string &name) const
381 content_t id = CONTENT_IGNORE;
385 virtual void getIds(const std::string &name, std::set<content_t> &result)
388 if(name.substr(0,6) != "group:"){
389 content_t id = CONTENT_IGNORE;
394 std::string group = name.substr(6);
395 for(u16 id=0; id<=MAX_CONTENT; id++)
397 const ContentFeatures &f = m_content_features[id];
398 if(f.name == "") // Quickly discard undefined nodes
400 if(itemgroup_get(f.groups, group) != 0)
404 virtual const ContentFeatures& get(const std::string &name) const
406 content_t id = CONTENT_IGNORE;
410 // IWritableNodeDefManager
411 virtual void set(content_t c, const ContentFeatures &def)
413 verbosestream<<"registerNode: registering content id \""<<c
414 <<"\": name=\""<<def.name<<"\""<<std::endl;
415 assert(c <= MAX_CONTENT);
416 // Don't allow redefining CONTENT_IGNORE (but allow air)
417 if(def.name == "ignore" || c == CONTENT_IGNORE){
418 infostream<<"registerNode: WARNING: Ignoring "
419 <<"CONTENT_IGNORE redefinition"<<std::endl;
422 // Check that the special contents are not redefined as different id
423 // because it would mess up everything
424 if((def.name == "ignore" && c != CONTENT_IGNORE) ||
425 (def.name == "air" && c != CONTENT_AIR)){
426 errorstream<<"registerNode: IGNORING ERROR: "
427 <<"trying to register built-in type \""
428 <<def.name<<"\" as different id"<<std::endl;
431 m_content_features[c] = def;
433 addNameIdMapping(c, def.name);
435 virtual content_t set(const std::string &name,
436 const ContentFeatures &def)
438 assert(name == def.name);
439 u16 id = CONTENT_IGNORE;
440 bool found = m_name_id_mapping.getId(name, id); // ignore aliases
442 // Determine if full param2 is required
443 bool require_full_param2 = (
444 def.param_type_2 == CPT2_FULL
446 def.param_type_2 == CPT2_FLOWINGLIQUID
448 def.legacy_wallmounted
451 id = getFreeId(require_full_param2);
452 if(id == CONTENT_IGNORE)
453 return CONTENT_IGNORE;
455 addNameIdMapping(id, name);
460 virtual content_t allocateDummy(const std::string &name)
467 virtual void updateAliases(IItemDefManager *idef)
469 std::set<std::string> all = idef->getAll();
470 m_name_id_mapping_with_aliases.clear();
471 for(std::set<std::string>::iterator
472 i = all.begin(); i != all.end(); i++)
474 std::string name = *i;
475 std::string convert_to = idef->getAlias(name);
477 if(m_name_id_mapping.getId(convert_to, id))
479 m_name_id_mapping_with_aliases.insert(
480 std::make_pair(name, id));
484 virtual void updateTextures(ITextureSource *tsrc)
487 infostream<<"CNodeDefManager::updateTextures(): Updating "
488 <<"textures in node definitions"<<std::endl;
490 bool new_style_water = g_settings->getBool("new_style_water");
491 bool new_style_leaves = g_settings->getBool("new_style_leaves");
492 bool opaque_water = g_settings->getBool("opaque_water");
494 for(u16 i=0; i<=MAX_CONTENT; i++)
496 ContentFeatures *f = &m_content_features[i];
498 std::string tname_tiles[6];
499 for(u32 j=0; j<6; j++)
501 tname_tiles[j] = f->tname_tiles[j];
502 if(tname_tiles[j] == "")
503 tname_tiles[j] = "unknown_block.png";
515 assert(f->liquid_type == LIQUID_SOURCE);
524 f->backface_culling = false;
527 case NDT_FLOWINGLIQUID:
528 assert(f->liquid_type == LIQUID_FLOWING);
535 f->visual_solidness = 1;
539 f->visual_solidness = 1;
541 case NDT_ALLFACES_OPTIONAL:
542 if(new_style_leaves){
543 f->drawtype = NDT_ALLFACES;
545 f->visual_solidness = 1;
547 f->drawtype = NDT_NORMAL;
549 for(u32 i=0; i<6; i++){
550 tname_tiles[i] += std::string("^[noalpha");
564 for(u16 j=0; j<6; j++){
565 f->tiles[j].texture = tsrc->getTexture(tname_tiles[j]);
566 f->tiles[j].alpha = f->alpha;
568 f->tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
570 f->tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
571 f->tiles[j].material_flags = 0;
572 if(f->backface_culling)
573 f->tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
576 for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
577 f->special_tiles[j].texture = tsrc->getTexture(f->mspec_special[j].tname);
578 f->special_tiles[j].alpha = f->alpha;
580 f->special_tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
582 f->special_tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
583 f->special_tiles[j].material_flags = 0;
584 if(f->mspec_special[j].backface_culling)
585 f->special_tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
590 void serialize(std::ostream &os)
592 writeU8(os, 1); // version
594 std::ostringstream os2(std::ios::binary);
595 for(u16 i=0; i<=MAX_CONTENT; i++)
597 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
599 ContentFeatures *f = &m_content_features[i];
603 // Wrap it in a string to allow different lengths without
604 // strict version incompatibilities
605 std::ostringstream wrapper_os(std::ios::binary);
606 f->serialize(wrapper_os);
607 os2<<serializeString(wrapper_os.str());
611 os<<serializeLongString(os2.str());
613 void deSerialize(std::istream &is)
616 int version = readU8(is);
618 throw SerializationError("unsupported NodeDefinitionManager version");
619 u16 count = readU16(is);
620 std::istringstream is2(deSerializeLongString(is), std::ios::binary);
621 for(u16 n=0; n<count; n++){
622 u16 i = readU16(is2);
624 errorstream<<"ContentFeatures::deSerialize(): "
625 <<"Too large content id: "<<i<<std::endl;
628 /*// Do not deserialize special types
629 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
631 ContentFeatures *f = &m_content_features[i];
632 // Read it from the string wrapper
633 std::string wrapper = deSerializeString(is2);
634 std::istringstream wrapper_is(wrapper, std::ios::binary);
635 f->deSerialize(wrapper_is);
636 verbosestream<<"deserialized "<<f->name<<std::endl;
638 addNameIdMapping(i, f->name);
642 void addNameIdMapping(content_t i, std::string name)
644 m_name_id_mapping.set(i, name);
645 m_name_id_mapping_with_aliases.insert(std::make_pair(name, i));
648 // Features indexed by id
649 ContentFeatures m_content_features[MAX_CONTENT+1];
650 // A mapping for fast converting back and forth between names and ids
651 NameIdMapping m_name_id_mapping;
652 // Like m_name_id_mapping, but only from names to ids, and includes
653 // item aliases too. Updated by updateAliases()
654 // Note: Not serialized.
655 std::map<std::string, content_t> m_name_id_mapping_with_aliases;
658 IWritableNodeDefManager* createNodeDefManager()
660 return new CNodeDefManager();