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 General Public License as published by
7 the Free Software Foundation; either version 2 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 General Public License for more details.
15 You should have received a copy of the GNU 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;
123 NOTE: Most of this is always overridden by the default values given
128 // Unknown nodes can be dug
129 groups["dig_immediate"] = 2;
130 drawtype = NDT_NORMAL;
132 for(u32 i=0; i<6; i++)
134 for(u16 j=0; j<CF_SPECIAL_COUNT; j++)
135 mspec_special[j] = MaterialSpec();
137 post_effect_color = video::SColor(0, 0, 0, 0);
138 param_type = CPT_NONE;
139 param_type_2 = CPT2_NONE;
140 is_ground_content = false;
141 light_propagates = false;
142 sunlight_propagates = false;
147 buildable_to = false;
149 liquid_type = LIQUID_NONE;
150 liquid_alternative_flowing = "";
151 liquid_alternative_source = "";
152 liquid_viscosity = 0;
154 damage_per_second = 0;
155 selection_box = NodeBox();
156 legacy_facedir_simple = false;
157 legacy_wallmounted = false;
158 sound_footstep = SimpleSoundSpec();
159 sound_dig = SimpleSoundSpec("__group");
160 sound_dug = SimpleSoundSpec();
163 void ContentFeatures::serialize(std::ostream &os)
165 writeU8(os, 3); // version
166 os<<serializeString(name);
167 writeU16(os, groups.size());
168 for(ItemGroupList::const_iterator
169 i = groups.begin(); i != groups.end(); i++){
170 os<<serializeString(i->first);
171 writeS16(os, i->second);
173 writeU8(os, drawtype);
174 writeF1000(os, visual_scale);
176 for(u32 i=0; i<6; i++)
177 os<<serializeString(tname_tiles[i]);
178 writeU8(os, CF_SPECIAL_COUNT);
179 for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
180 mspec_special[i].serialize(os);
183 writeU8(os, post_effect_color.getAlpha());
184 writeU8(os, post_effect_color.getRed());
185 writeU8(os, post_effect_color.getGreen());
186 writeU8(os, post_effect_color.getBlue());
187 writeU8(os, param_type);
188 writeU8(os, param_type_2);
189 writeU8(os, is_ground_content);
190 writeU8(os, light_propagates);
191 writeU8(os, sunlight_propagates);
192 writeU8(os, walkable);
193 writeU8(os, pointable);
194 writeU8(os, diggable);
195 writeU8(os, climbable);
196 writeU8(os, buildable_to);
197 os<<serializeString(metadata_name);
198 writeU8(os, liquid_type);
199 os<<serializeString(liquid_alternative_flowing);
200 os<<serializeString(liquid_alternative_source);
201 writeU8(os, liquid_viscosity);
202 writeU8(os, light_source);
203 writeU32(os, damage_per_second);
204 selection_box.serialize(os);
205 writeU8(os, legacy_facedir_simple);
206 writeU8(os, legacy_wallmounted);
207 serializeSimpleSoundSpec(sound_footstep, os);
208 serializeSimpleSoundSpec(sound_dig, os);
209 serializeSimpleSoundSpec(sound_dug, os);
212 void ContentFeatures::deSerialize(std::istream &is)
214 int version = readU8(is);
216 throw SerializationError("unsupported ContentFeatures version");
217 name = deSerializeString(is);
219 u32 groups_size = readU16(is);
220 for(u32 i=0; i<groups_size; i++){
221 std::string name = deSerializeString(is);
222 int value = readS16(is);
223 groups[name] = value;
225 drawtype = (enum NodeDrawType)readU8(is);
226 visual_scale = readF1000(is);
228 throw SerializationError("unsupported tile count");
229 for(u32 i=0; i<6; i++)
230 tname_tiles[i] = deSerializeString(is);
231 if(readU8(is) != CF_SPECIAL_COUNT)
232 throw SerializationError("unsupported CF_SPECIAL_COUNT");
233 for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
234 mspec_special[i].deSerialize(is);
237 post_effect_color.setAlpha(readU8(is));
238 post_effect_color.setRed(readU8(is));
239 post_effect_color.setGreen(readU8(is));
240 post_effect_color.setBlue(readU8(is));
241 param_type = (enum ContentParamType)readU8(is);
242 param_type_2 = (enum ContentParamType2)readU8(is);
243 is_ground_content = readU8(is);
244 light_propagates = readU8(is);
245 sunlight_propagates = readU8(is);
246 walkable = readU8(is);
247 pointable = readU8(is);
248 diggable = readU8(is);
249 climbable = readU8(is);
250 buildable_to = readU8(is);
251 metadata_name = deSerializeString(is);
252 liquid_type = (enum LiquidType)readU8(is);
253 liquid_alternative_flowing = deSerializeString(is);
254 liquid_alternative_source = deSerializeString(is);
255 liquid_viscosity = readU8(is);
256 light_source = readU8(is);
257 damage_per_second = readU32(is);
258 selection_box.deSerialize(is);
259 legacy_facedir_simple = readU8(is);
260 legacy_wallmounted = readU8(is);
261 // If you add anything here, insert it primarily inside the try-catch
262 // block to not need to increase the version.
264 deSerializeSimpleSoundSpec(sound_footstep, is);
265 deSerializeSimpleSoundSpec(sound_dig, is);
266 deSerializeSimpleSoundSpec(sound_dug, is);
267 }catch(SerializationError &e) {};
274 class CNodeDefManager: public IWritableNodeDefManager
279 m_name_id_mapping.clear();
280 m_name_id_mapping_with_aliases.clear();
282 for(u16 i=0; i<=MAX_CONTENT; i++)
284 ContentFeatures &f = m_content_features[i];
285 f.reset(); // Reset to defaults
292 f.drawtype = NDT_AIRLIKE;
293 f.param_type = CPT_LIGHT;
294 f.light_propagates = true;
295 f.sunlight_propagates = true;
299 f.buildable_to = true;
300 // Insert directly into containers
301 content_t c = CONTENT_AIR;
302 m_content_features[c] = f;
303 addNameIdMapping(c, f.name);
305 // Set CONTENT_IGNORE
309 f.drawtype = NDT_AIRLIKE;
310 f.param_type = CPT_NONE;
311 f.light_propagates = false;
312 f.sunlight_propagates = false;
316 // A way to remove accidental CONTENT_IGNOREs
317 f.buildable_to = true;
318 // Insert directly into containers
319 content_t c = CONTENT_IGNORE;
320 m_content_features[c] = f;
321 addNameIdMapping(c, f.name);
324 // CONTENT_IGNORE = not found
325 content_t getFreeId(bool require_full_param2)
327 // If allowed, first search in the large 4-bit-param2 pool
328 if(!require_full_param2){
329 for(u16 i=0x800; i<=0xfff; i++){
330 const ContentFeatures &f = m_content_features[i];
335 // Then search from the small 8-bit-param2 pool
336 for(u16 i=0; i<=125; i++){
337 const ContentFeatures &f = m_content_features[i];
341 return CONTENT_IGNORE;
347 virtual ~CNodeDefManager()
350 virtual IWritableNodeDefManager* clone()
352 CNodeDefManager *mgr = new CNodeDefManager();
353 for(u16 i=0; i<=MAX_CONTENT; i++)
359 virtual const ContentFeatures& get(content_t c) const
361 assert(c <= MAX_CONTENT);
362 return m_content_features[c];
364 virtual const ContentFeatures& get(const MapNode &n) const
366 return get(n.getContent());
368 virtual bool getId(const std::string &name, content_t &result) const
370 std::map<std::string, content_t>::const_iterator
371 i = m_name_id_mapping_with_aliases.find(name);
372 if(i == m_name_id_mapping_with_aliases.end())
377 virtual content_t getId(const std::string &name) const
379 content_t id = CONTENT_IGNORE;
383 virtual const ContentFeatures& get(const std::string &name) const
385 content_t id = CONTENT_IGNORE;
389 // IWritableNodeDefManager
390 virtual void set(content_t c, const ContentFeatures &def)
392 verbosestream<<"registerNode: registering content id \""<<c
393 <<"\": name=\""<<def.name<<"\""<<std::endl;
394 assert(c <= MAX_CONTENT);
395 // Don't allow redefining CONTENT_IGNORE (but allow air)
396 if(def.name == "ignore" || c == CONTENT_IGNORE){
397 infostream<<"registerNode: WARNING: Ignoring "
398 <<"CONTENT_IGNORE redefinition"<<std::endl;
401 // Check that the special contents are not redefined as different id
402 // because it would mess up everything
403 if((def.name == "ignore" && c != CONTENT_IGNORE) ||
404 (def.name == "air" && c != CONTENT_AIR)){
405 errorstream<<"registerNode: IGNORING ERROR: "
406 <<"trying to register built-in type \""
407 <<def.name<<"\" as different id"<<std::endl;
410 m_content_features[c] = def;
412 addNameIdMapping(c, def.name);
414 virtual content_t set(const std::string &name,
415 const ContentFeatures &def)
417 assert(name == def.name);
418 u16 id = CONTENT_IGNORE;
419 bool found = m_name_id_mapping.getId(name, id); // ignore aliases
421 // Determine if full param2 is required
422 bool require_full_param2 = (
423 def.param_type_2 == CPT2_FULL
425 def.param_type_2 == CPT2_FLOWINGLIQUID
427 def.legacy_wallmounted
430 id = getFreeId(require_full_param2);
431 if(id == CONTENT_IGNORE)
432 return CONTENT_IGNORE;
434 addNameIdMapping(id, name);
439 virtual content_t allocateDummy(const std::string &name)
446 virtual void updateAliases(IItemDefManager *idef)
448 std::set<std::string> all = idef->getAll();
449 m_name_id_mapping_with_aliases.clear();
450 for(std::set<std::string>::iterator
451 i = all.begin(); i != all.end(); i++)
453 std::string name = *i;
454 std::string convert_to = idef->getAlias(name);
456 if(m_name_id_mapping.getId(convert_to, id))
458 m_name_id_mapping_with_aliases.insert(
459 std::make_pair(name, id));
463 virtual void updateTextures(ITextureSource *tsrc)
466 infostream<<"CNodeDefManager::updateTextures(): Updating "
467 <<"textures in node definitions"<<std::endl;
469 bool new_style_water = g_settings->getBool("new_style_water");
470 bool new_style_leaves = g_settings->getBool("new_style_leaves");
471 bool opaque_water = g_settings->getBool("opaque_water");
473 for(u16 i=0; i<=MAX_CONTENT; i++)
475 ContentFeatures *f = &m_content_features[i];
477 std::string tname_tiles[6];
478 for(u32 j=0; j<6; j++)
480 tname_tiles[j] = f->tname_tiles[j];
481 if(tname_tiles[j] == "")
482 tname_tiles[j] = "unknown_block.png";
494 assert(f->liquid_type == LIQUID_SOURCE);
503 f->backface_culling = false;
506 case NDT_FLOWINGLIQUID:
507 assert(f->liquid_type == LIQUID_FLOWING);
514 f->visual_solidness = 1;
518 f->visual_solidness = 1;
520 case NDT_ALLFACES_OPTIONAL:
521 if(new_style_leaves){
522 f->drawtype = NDT_ALLFACES;
524 f->visual_solidness = 1;
526 f->drawtype = NDT_NORMAL;
528 for(u32 i=0; i<6; i++){
529 tname_tiles[i] += std::string("^[noalpha");
543 for(u16 j=0; j<6; j++){
544 f->tiles[j].texture = tsrc->getTexture(tname_tiles[j]);
545 f->tiles[j].alpha = f->alpha;
547 f->tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
549 f->tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
550 f->tiles[j].material_flags = 0;
551 if(f->backface_culling)
552 f->tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
555 for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
556 f->special_tiles[j].texture = tsrc->getTexture(f->mspec_special[j].tname);
557 f->special_tiles[j].alpha = f->alpha;
559 f->special_tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
561 f->special_tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
562 f->special_tiles[j].material_flags = 0;
563 if(f->mspec_special[j].backface_culling)
564 f->special_tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
569 void serialize(std::ostream &os)
571 writeU8(os, 1); // version
573 std::ostringstream os2(std::ios::binary);
574 for(u16 i=0; i<=MAX_CONTENT; i++)
576 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
578 ContentFeatures *f = &m_content_features[i];
582 // Wrap it in a string to allow different lengths without
583 // strict version incompatibilities
584 std::ostringstream wrapper_os(std::ios::binary);
585 f->serialize(wrapper_os);
586 os2<<serializeString(wrapper_os.str());
590 os<<serializeLongString(os2.str());
592 void deSerialize(std::istream &is)
595 int version = readU8(is);
597 throw SerializationError("unsupported NodeDefinitionManager version");
598 u16 count = readU16(is);
599 std::istringstream is2(deSerializeLongString(is), std::ios::binary);
600 for(u16 n=0; n<count; n++){
601 u16 i = readU16(is2);
603 errorstream<<"ContentFeatures::deSerialize(): "
604 <<"Too large content id: "<<i<<std::endl;
607 /*// Do not deserialize special types
608 if(i == CONTENT_IGNORE || i == CONTENT_AIR)
610 ContentFeatures *f = &m_content_features[i];
611 // Read it from the string wrapper
612 std::string wrapper = deSerializeString(is2);
613 std::istringstream wrapper_is(wrapper, std::ios::binary);
614 f->deSerialize(wrapper_is);
616 addNameIdMapping(i, f->name);
620 void addNameIdMapping(content_t i, std::string name)
622 m_name_id_mapping.set(i, name);
623 m_name_id_mapping_with_aliases.insert(std::make_pair(name, i));
626 // Features indexed by id
627 ContentFeatures m_content_features[MAX_CONTENT+1];
628 // A mapping for fast converting back and forth between names and ids
629 NameIdMapping m_name_id_mapping;
630 // Like m_name_id_mapping, but only from names to ids, and includes
631 // item aliases too. Updated by updateAliases()
632 // Note: Not serialized.
633 std::map<std::string, content_t> m_name_id_mapping_with_aliases;
636 IWritableNodeDefManager* createNodeDefManager()
638 return new CNodeDefManager();