src/nodedef.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #include "nodedef.h"
  21
  22 #include "main.h" // For g_settings
  23 #include "itemdef.h"
  24 #ifndef SERVER
  25 #include "tile.h"
  26 #endif
  27 #include "log.h"
  28 #include "settings.h"
  29 #include "nameidmapping.h"
  30 #include "util/numeric.h"
  31 #include "util/serialize.h"
  32 //#include "profiler.h" // For TimeTaker
  33
  34 /*
  35         NodeBox
  36 */
  37
  38 void NodeBox::reset()
  39 {
  40         type = NODEBOX_REGULAR;
  41         // default is empty
  42         fixed.clear();
  43         // default is sign/ladder-like
  44         wall_top = aabb3f(-BS/2, BS/2-BS/16., -BS/2, BS/2, BS/2, BS/2);
  45         wall_bottom = aabb3f(-BS/2, -BS/2, -BS/2, BS/2, -BS/2+BS/16., BS/2);
  46         wall_side = aabb3f(-BS/2, -BS/2, -BS/2, -BS/2+BS/16., BS/2, BS/2);
  47 }
  48
  49 void NodeBox::serialize(std::ostream &os, u16 protocol_version) const
  50 {
  51         int version = protocol_version >= 21 ? 2 : 1;
  52         writeU8(os, version);
  53
  54         if (version == 1 && type == NODEBOX_LEVELED)
  55                 writeU8(os, NODEBOX_FIXED);
  56         else
  57                 writeU8(os, type);
  58
  59         if(type == NODEBOX_FIXED || type == NODEBOX_LEVELED)
  60         {
  61                 writeU16(os, fixed.size());
  62                 for(std::vector<aabb3f>::const_iterator
  63                                 i = fixed.begin();
  64                                 i != fixed.end(); i++)
  65                 {
  66                         writeV3F1000(os, i->MinEdge);
  67                         writeV3F1000(os, i->MaxEdge);
  68                 }
  69         }
  70         else if(type == NODEBOX_WALLMOUNTED)
  71         {
  72                 writeV3F1000(os, wall_top.MinEdge);
  73                 writeV3F1000(os, wall_top.MaxEdge);
  74                 writeV3F1000(os, wall_bottom.MinEdge);
  75                 writeV3F1000(os, wall_bottom.MaxEdge);
  76                 writeV3F1000(os, wall_side.MinEdge);
  77                 writeV3F1000(os, wall_side.MaxEdge);
  78         }
  79 }
  80
  81 void NodeBox::deSerialize(std::istream &is)
  82 {
  83         int version = readU8(is);
  84         if(version < 1 || version > 2)
  85                 throw SerializationError("unsupported NodeBox version");
  86
  87         reset();
  88
  89         type = (enum NodeBoxType)readU8(is);
  90
  91         if(type == NODEBOX_FIXED || type == NODEBOX_LEVELED)
  92         {
  93                 u16 fixed_count = readU16(is);
  94                 while(fixed_count--)
  95                 {
  96                         aabb3f box;
  97                         box.MinEdge = readV3F1000(is);
  98                         box.MaxEdge = readV3F1000(is);
  99                         fixed.push_back(box);
 100                 }
 101         }
 102         else if(type == NODEBOX_WALLMOUNTED)
 103         {
 104                 wall_top.MinEdge = readV3F1000(is);
 105                 wall_top.MaxEdge = readV3F1000(is);
 106                 wall_bottom.MinEdge = readV3F1000(is);
 107                 wall_bottom.MaxEdge = readV3F1000(is);
 108                 wall_side.MinEdge = readV3F1000(is);
 109                 wall_side.MaxEdge = readV3F1000(is);
 110         }
 111 }
 112
 113 /*
 114         TileDef
 115 */
 116
 117 void TileDef::serialize(std::ostream &os, u16 protocol_version) const
 118 {
 119         if(protocol_version >= 17)
 120                 writeU8(os, 1);
 121         else
 122                 writeU8(os, 0);
 123         os<<serializeString(name);
 124         writeU8(os, animation.type);
 125         writeU16(os, animation.aspect_w);
 126         writeU16(os, animation.aspect_h);
 127         writeF1000(os, animation.length);
 128         if(protocol_version >= 17)
 129                 writeU8(os, backface_culling);
 130 }
 131
 132 void TileDef::deSerialize(std::istream &is)
 133 {
 134         int version = readU8(is);
 135         name = deSerializeString(is);
 136         animation.type = (TileAnimationType)readU8(is);
 137         animation.aspect_w = readU16(is);
 138         animation.aspect_h = readU16(is);
 139         animation.length = readF1000(is);
 140         if(version >= 1)
 141                 backface_culling = readU8(is);
 142 }
 143
 144 /*
 145         SimpleSoundSpec serialization
 146 */
 147
 148 static void serializeSimpleSoundSpec(const SimpleSoundSpec &ss,
 149                 std::ostream &os)
 150 {
 151         os<<serializeString(ss.name);
 152         writeF1000(os, ss.gain);
 153 }
 154 static void deSerializeSimpleSoundSpec(SimpleSoundSpec &ss, std::istream &is)
 155 {
 156         ss.name = deSerializeString(is);
 157         ss.gain = readF1000(is);
 158 }
 159
 160 /*
 161         ContentFeatures
 162 */
 163
 164 ContentFeatures::ContentFeatures()
 165 {
 166         reset();
 167 }
 168
 169 ContentFeatures::~ContentFeatures()
 170 {
 171 }
 172
 173 void ContentFeatures::reset()
 174 {
 175         /*
 176                 Cached stuff
 177         */
 178 #ifndef SERVER
 179         solidness = 2;
 180         visual_solidness = 0;
 181         backface_culling = true;
 182 #endif
 183         has_on_construct = false;
 184         has_on_destruct = false;
 185         has_after_destruct = false;
 186         /*
 187                 Actual data
 188
 189                 NOTE: Most of this is always overridden by the default values given
 190                       in builtin.lua
 191         */
 192         name = "";
 193         groups.clear();
 194         // Unknown nodes can be dug
 195         groups["dig_immediate"] = 2;
 196         drawtype = NDT_NORMAL;
 197         visual_scale = 1.0;
 198         for(u32 i=0; i<6; i++)
 199                 tiledef[i] = TileDef();
 200         for(u16 j=0; j<CF_SPECIAL_COUNT; j++)
 201                 tiledef_special[j] = TileDef();
 202         alpha = 255;
 203         post_effect_color = video::SColor(0, 0, 0, 0);
 204         param_type = CPT_NONE;
 205         param_type_2 = CPT2_NONE;
 206         is_ground_content = false;
 207         light_propagates = false;
 208         sunlight_propagates = false;
 209         walkable = true;
 210         pointable = true;
 211         diggable = true;
 212         climbable = false;
 213         buildable_to = false;
 214         rightclickable = true;
 215         leveled = 0;
 216         liquid_type = LIQUID_NONE;
 217         liquid_alternative_flowing = "";
 218         liquid_alternative_source = "";
 219         liquid_viscosity = 0;
 220         liquid_renewable = true;
 221         freezemelt = "";
 222         liquid_range = LIQUID_LEVEL_MAX+1;
 223         drowning = 0;
 224         light_source = 0;
 225         damage_per_second = 0;
 226         node_box = NodeBox();
 227         selection_box = NodeBox();
 228         waving = 0;
 229         legacy_facedir_simple = false;
 230         legacy_wallmounted = false;
 231         sound_footstep = SimpleSoundSpec();
 232         sound_dig = SimpleSoundSpec("__group");
 233         sound_dug = SimpleSoundSpec();
 234 }
 235
 236 void ContentFeatures::serialize(std::ostream &os, u16 protocol_version)
 237 {
 238         if(protocol_version < 14){
 239                 serializeOld(os, protocol_version);
 240                 return;
 241         }
 242
 243         writeU8(os, 6); // version
 244         os<<serializeString(name);
 245         writeU16(os, groups.size());
 246         for(ItemGroupList::const_iterator
 247                         i = groups.begin(); i != groups.end(); i++){
 248                 os<<serializeString(i->first);
 249                 writeS16(os, i->second);
 250         }
 251         writeU8(os, drawtype);
 252         writeF1000(os, visual_scale);
 253         writeU8(os, 6);
 254         for(u32 i=0; i<6; i++)
 255                 tiledef[i].serialize(os, protocol_version);
 256         writeU8(os, CF_SPECIAL_COUNT);
 257         for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
 258                 tiledef_special[i].serialize(os, protocol_version);
 259         }
 260         writeU8(os, alpha);
 261         writeU8(os, post_effect_color.getAlpha());
 262         writeU8(os, post_effect_color.getRed());
 263         writeU8(os, post_effect_color.getGreen());
 264         writeU8(os, post_effect_color.getBlue());
 265         writeU8(os, param_type);
 266         writeU8(os, param_type_2);
 267         writeU8(os, is_ground_content);
 268         writeU8(os, light_propagates);
 269         writeU8(os, sunlight_propagates);
 270         writeU8(os, walkable);
 271         writeU8(os, pointable);
 272         writeU8(os, diggable);
 273         writeU8(os, climbable);
 274         writeU8(os, buildable_to);
 275         os<<serializeString(""); // legacy: used to be metadata_name
 276         writeU8(os, liquid_type);
 277         os<<serializeString(liquid_alternative_flowing);
 278         os<<serializeString(liquid_alternative_source);
 279         writeU8(os, liquid_viscosity);
 280         writeU8(os, liquid_renewable);
 281         writeU8(os, light_source);
 282         writeU32(os, damage_per_second);
 283         node_box.serialize(os, protocol_version);
 284         selection_box.serialize(os, protocol_version);
 285         writeU8(os, legacy_facedir_simple);
 286         writeU8(os, legacy_wallmounted);
 287         serializeSimpleSoundSpec(sound_footstep, os);
 288         serializeSimpleSoundSpec(sound_dig, os);
 289         serializeSimpleSoundSpec(sound_dug, os);
 290         writeU8(os, rightclickable);
 291         writeU8(os, drowning);
 292         writeU8(os, leveled);
 293         writeU8(os, liquid_range);
 294         // Stuff below should be moved to correct place in a version that otherwise changes
 295         // the protocol version
 296         writeU8(os, waving);
 297 }
 298
 299 void ContentFeatures::deSerialize(std::istream &is)
 300 {
 301         int version = readU8(is);
 302         if(version != 6){
 303                 deSerializeOld(is, version);
 304                 return;
 305         }
 306
 307         name = deSerializeString(is);
 308         groups.clear();
 309         u32 groups_size = readU16(is);
 310         for(u32 i=0; i<groups_size; i++){
 311                 std::string name = deSerializeString(is);
 312                 int value = readS16(is);
 313                 groups[name] = value;
 314         }
 315         drawtype = (enum NodeDrawType)readU8(is);
 316         visual_scale = readF1000(is);
 317         if(readU8(is) != 6)
 318                 throw SerializationError("unsupported tile count");
 319         for(u32 i=0; i<6; i++)
 320                 tiledef[i].deSerialize(is);
 321         if(readU8(is) != CF_SPECIAL_COUNT)
 322                 throw SerializationError("unsupported CF_SPECIAL_COUNT");
 323         for(u32 i=0; i<CF_SPECIAL_COUNT; i++)
 324                 tiledef_special[i].deSerialize(is);
 325         alpha = readU8(is);
 326         post_effect_color.setAlpha(readU8(is));
 327         post_effect_color.setRed(readU8(is));
 328         post_effect_color.setGreen(readU8(is));
 329         post_effect_color.setBlue(readU8(is));
 330         param_type = (enum ContentParamType)readU8(is);
 331         param_type_2 = (enum ContentParamType2)readU8(is);
 332         is_ground_content = readU8(is);
 333         light_propagates = readU8(is);
 334         sunlight_propagates = readU8(is);
 335         walkable = readU8(is);
 336         pointable = readU8(is);
 337         diggable = readU8(is);
 338         climbable = readU8(is);
 339         buildable_to = readU8(is);
 340         deSerializeString(is); // legacy: used to be metadata_name
 341         liquid_type = (enum LiquidType)readU8(is);
 342         liquid_alternative_flowing = deSerializeString(is);
 343         liquid_alternative_source = deSerializeString(is);
 344         liquid_viscosity = readU8(is);
 345         liquid_renewable = readU8(is);
 346         light_source = readU8(is);
 347         damage_per_second = readU32(is);
 348         node_box.deSerialize(is);
 349         selection_box.deSerialize(is);
 350         legacy_facedir_simple = readU8(is);
 351         legacy_wallmounted = readU8(is);
 352         deSerializeSimpleSoundSpec(sound_footstep, is);
 353         deSerializeSimpleSoundSpec(sound_dig, is);
 354         deSerializeSimpleSoundSpec(sound_dug, is);
 355         rightclickable = readU8(is);
 356         drowning = readU8(is);
 357         leveled = readU8(is);
 358         liquid_range = readU8(is);
 359         // If you add anything here, insert it primarily inside the try-catch
 360         // block to not need to increase the version.
 361         try{
 362                 // Stuff below should be moved to correct place in a version that
 363                 // otherwise changes the protocol version
 364         waving = readU8(is);
 365         }catch(SerializationError &e) {};
 366 }
 367
 368 /*
 369         CNodeDefManager
 370 */
 371
 372 class CNodeDefManager: public IWritableNodeDefManager
 373 {
 374 public:
 375         void clear()
 376         {
 377                 m_content_features.clear();
 378                 m_name_id_mapping.clear();
 379                 m_name_id_mapping_with_aliases.clear();
 380                 m_group_to_items.clear();
 381                 m_next_id = 0;
 382
 383                 u32 initial_length = 0;
 384                 initial_length = MYMAX(initial_length, CONTENT_UNKNOWN + 1);
 385                 initial_length = MYMAX(initial_length, CONTENT_AIR + 1);
 386                 initial_length = MYMAX(initial_length, CONTENT_IGNORE + 1);
 387                 m_content_features.resize(initial_length);
 388
 389                 // Set CONTENT_UNKNOWN
 390                 {
 391                         ContentFeatures f;
 392                         f.name = "unknown";
 393                         // Insert directly into containers
 394                         content_t c = CONTENT_UNKNOWN;
 395                         m_content_features[c] = f;
 396                         addNameIdMapping(c, f.name);
 397                 }
 398
 399                 // Set CONTENT_AIR
 400                 {
 401                         ContentFeatures f;
 402                         f.name                = "air";
 403                         f.drawtype            = NDT_AIRLIKE;
 404                         f.param_type          = CPT_LIGHT;
 405                         f.light_propagates    = true;
 406                         f.sunlight_propagates = true;
 407                         f.walkable            = false;
 408                         f.pointable           = false;
 409                         f.diggable            = false;
 410                         f.buildable_to        = true;
 411                         f.is_ground_content   = true;
 412                         // Insert directly into containers
 413                         content_t c = CONTENT_AIR;
 414                         m_content_features[c] = f;
 415                         addNameIdMapping(c, f.name);
 416                 }
 417
 418                 // Set CONTENT_IGNORE
 419                 {
 420                         ContentFeatures f;
 421                         f.name                = "ignore";
 422                         f.drawtype            = NDT_AIRLIKE;
 423                         f.param_type          = CPT_NONE;
 424                         f.light_propagates    = false;
 425                         f.sunlight_propagates = false;
 426                         f.walkable            = false;
 427                         f.pointable           = false;
 428                         f.diggable            = false;
 429                         f.buildable_to        = true; // A way to remove accidental CONTENT_IGNOREs
 430                         f.is_ground_content   = true;
 431                         // Insert directly into containers
 432                         content_t c = CONTENT_IGNORE;
 433                         m_content_features[c] = f;
 434                         addNameIdMapping(c, f.name);
 435                 }
 436         }
 437         CNodeDefManager()
 438         {
 439                 clear();
 440         }
 441         virtual ~CNodeDefManager()
 442         {
 443         }
 444         virtual IWritableNodeDefManager* clone()
 445         {
 446                 CNodeDefManager *mgr = new CNodeDefManager();
 447                 *mgr = *this;
 448                 return mgr;
 449         }
 450         virtual const ContentFeatures& get(content_t c) const
 451         {
 452                 if(c < m_content_features.size())
 453                         return m_content_features[c];
 454                 else
 455                         return m_content_features[CONTENT_UNKNOWN];
 456         }
 457         virtual const ContentFeatures& get(const MapNode &n) const
 458         {
 459                 return get(n.getContent());
 460         }
 461         virtual bool getId(const std::string &name, content_t &result) const
 462         {
 463                 std::map<std::string, content_t>::const_iterator
 464                         i = m_name_id_mapping_with_aliases.find(name);
 465                 if(i == m_name_id_mapping_with_aliases.end())
 466                         return false;
 467                 result = i->second;
 468                 return true;
 469         }
 470         virtual content_t getId(const std::string &name) const
 471         {
 472                 content_t id = CONTENT_IGNORE;
 473                 getId(name, id);
 474                 return id;
 475         }
 476         virtual void getIds(const std::string &name, std::set<content_t> &result)
 477                         const
 478         {
 479                 //TimeTaker t("getIds", NULL, PRECISION_MICRO);
 480                 if(name.substr(0,6) != "group:"){
 481                         content_t id = CONTENT_IGNORE;
 482                         if(getId(name, id))
 483                                 result.insert(id);
 484                         return;
 485                 }
 486                 std::string group = name.substr(6);
 487
 488                 std::map<std::string, GroupItems>::const_iterator
 489                         i = m_group_to_items.find(group);
 490                 if (i == m_group_to_items.end())
 491                         return;
 492
 493                 const GroupItems &items = i->second;
 494                 for (GroupItems::const_iterator j = items.begin();
 495                         j != items.end(); ++j) {
 496                         if ((*j).second != 0)
 497                                 result.insert((*j).first);
 498                 }
 499                 //printf("getIds: %dus\n", t.stop());
 500         }
 501         virtual const ContentFeatures& get(const std::string &name) const
 502         {
 503                 content_t id = CONTENT_UNKNOWN;
 504                 getId(name, id);
 505                 return get(id);
 506         }
 507         // returns CONTENT_IGNORE if no free ID found
 508         content_t allocateId()
 509         {
 510                 for(content_t id = m_next_id;
 511                                 id >= m_next_id; // overflow?
 512                                 ++id){
 513                         while(id >= m_content_features.size()){
 514                                 m_content_features.push_back(ContentFeatures());
 515                         }
 516                         const ContentFeatures &f = m_content_features[id];
 517                         if(f.name == ""){
 518                                 m_next_id = id + 1;
 519                                 return id;
 520                         }
 521                 }
 522                 // If we arrive here, an overflow occurred in id.
 523                 // That means no ID was found
 524                 return CONTENT_IGNORE;
 525         }
 526         // IWritableNodeDefManager
 527         virtual content_t set(const std::string &name,
 528                         const ContentFeatures &def)
 529         {
 530                 assert(name != "");
 531                 assert(name == def.name);
 532
 533                 // Don't allow redefining ignore (but allow air and unknown)
 534                 if(name == "ignore"){
 535                         infostream<<"NodeDefManager: WARNING: Ignoring "
 536                                         <<"CONTENT_IGNORE redefinition"<<std::endl;
 537                         return CONTENT_IGNORE;
 538                 }
 539
 540                 content_t id = CONTENT_IGNORE;
 541                 bool found = m_name_id_mapping.getId(name, id);  // ignore aliases
 542                 if(!found){
 543                         // Get new id
 544                         id = allocateId();
 545                         if(id == CONTENT_IGNORE){
 546                                 infostream<<"NodeDefManager: WARNING: Absolute "
 547                                                 <<"limit reached"<<std::endl;
 548                                 return CONTENT_IGNORE;
 549                         }
 550                         assert(id != CONTENT_IGNORE);
 551                         addNameIdMapping(id, name);
 552                 }
 553                 m_content_features[id] = def;
 554                 verbosestream<<"NodeDefManager: registering content id \""<<id
 555                                 <<"\": name=\""<<def.name<<"\""<<std::endl;
 556
 557                 // Add this content to the list of all groups it belongs to
 558                 // FIXME: This should remove a node from groups it no longer
 559                 // belongs to when a node is re-registered
 560                 for (ItemGroupList::const_iterator i = def.groups.begin();
 561                         i != def.groups.end(); ++i) {
 562                         std::string group_name = i->first;
 563
 564                         std::map<std::string, GroupItems>::iterator
 565                                 j = m_group_to_items.find(group_name);
 566                         if (j == m_group_to_items.end()) {
 567                                 m_group_to_items[group_name].push_back(
 568                                                 std::make_pair(id, i->second));
 569                         } else {
 570                                 GroupItems &items = j->second;
 571                                 items.push_back(std::make_pair(id, i->second));
 572                         }
 573                 }
 574                 return id;
 575         }
 576         virtual content_t allocateDummy(const std::string &name)
 577         {
 578                 assert(name != "");
 579                 ContentFeatures f;
 580                 f.name = name;
 581                 return set(name, f);
 582         }
 583         virtual void updateAliases(IItemDefManager *idef)
 584         {
 585                 std::set<std::string> all = idef->getAll();
 586                 m_name_id_mapping_with_aliases.clear();
 587                 for(std::set<std::string>::iterator
 588                                 i = all.begin(); i != all.end(); i++)
 589                 {
 590                         std::string name = *i;
 591                         std::string convert_to = idef->getAlias(name);
 592                         content_t id;
 593                         if(m_name_id_mapping.getId(convert_to, id))
 594                         {
 595                                 m_name_id_mapping_with_aliases.insert(
 596                                                 std::make_pair(name, id));
 597                         }
 598                 }
 599         }
 600         virtual void updateTextures(ITextureSource *tsrc)
 601         {
 602 #ifndef SERVER
 603                 infostream<<"CNodeDefManager::updateTextures(): Updating "
 604                                 <<"textures in node definitions"<<std::endl;
 605
 606                 bool new_style_water = g_settings->getBool("new_style_water");
 607                 bool new_style_leaves = g_settings->getBool("new_style_leaves");
 608                 bool opaque_water = g_settings->getBool("opaque_water");
 609
 610                 for(u32 i=0; i<m_content_features.size(); i++)
 611                 {
 612                         ContentFeatures *f = &m_content_features[i];
 613
 614                         // Figure out the actual tiles to use
 615                         TileDef tiledef[6];
 616                         for(u32 j=0; j<6; j++)
 617                         {
 618                                 tiledef[j] = f->tiledef[j];
 619                                 if(tiledef[j].name == "")
 620                                         tiledef[j].name = "unknown_node.png";
 621                         }
 622
 623                         bool is_liquid = false;
 624                         u8 material_type;
 625                         material_type = (f->alpha == 255) ? TILE_MATERIAL_BASIC : TILE_MATERIAL_ALPHA;
 626
 627                         switch(f->drawtype){
 628                         default:
 629                         case NDT_NORMAL:
 630                                 f->solidness = 2;
 631                                 break;
 632                         case NDT_AIRLIKE:
 633                                 f->solidness = 0;
 634                                 break;
 635                         case NDT_LIQUID:
 636                                 assert(f->liquid_type == LIQUID_SOURCE);
 637                                 if(opaque_water)
 638                                         f->alpha = 255;
 639                                 if(new_style_water){
 640                                         f->solidness = 0;
 641                                 } else {
 642                                         f->solidness = 1;
 643                                         f->backface_culling = false;
 644                                 }
 645                                 is_liquid = true;
 646                                 break;
 647                         case NDT_FLOWINGLIQUID:
 648                                 assert(f->liquid_type == LIQUID_FLOWING);
 649                                 f->solidness = 0;
 650                                 if(opaque_water)
 651                                         f->alpha = 255;
 652                                 is_liquid = true;
 653                                 break;
 654                         case NDT_GLASSLIKE:
 655                                 f->solidness = 0;
 656                                 f->visual_solidness = 1;
 657                                 break;
 658                         case NDT_GLASSLIKE_FRAMED:
 659                                 f->solidness = 0;
 660                                 f->visual_solidness = 1;
 661                                 break;
 662                         case NDT_ALLFACES:
 663                                 f->solidness = 0;
 664                                 f->visual_solidness = 1;
 665                                 break;
 666                         case NDT_ALLFACES_OPTIONAL:
 667                                 if(new_style_leaves){
 668                                         f->drawtype = NDT_ALLFACES;
 669                                         f->solidness = 0;
 670                                         f->visual_solidness = 1;
 671                                 } else {
 672                                         f->drawtype = NDT_NORMAL;
 673                                         f->solidness = 2;
 674                                         for(u32 i=0; i<6; i++){
 675                                                 tiledef[i].name += std::string("^[noalpha");
 676                                         }
 677                                 }
 678                                 if (f->waving == 1)
 679                                         material_type = TILE_MATERIAL_LEAVES;
 680                                 break;
 681                         case NDT_PLANTLIKE:
 682                                 f->solidness = 0;
 683                                 f->backface_culling = false;
 684                                 if (f->waving == 1)
 685                                         material_type = TILE_MATERIAL_PLANTS;
 686                                 break;
 687                         case NDT_TORCHLIKE:
 688                         case NDT_SIGNLIKE:
 689                         case NDT_FENCELIKE:
 690                         case NDT_RAILLIKE:
 691                         case NDT_NODEBOX:
 692                                 f->solidness = 0;
 693                                 break;
 694                         }
 695
 696                         if (is_liquid)
 697                                 material_type = (f->alpha == 255) ? TILE_MATERIAL_LIQUID_OPAQUE : TILE_MATERIAL_LIQUID_TRANSPARENT;
 698
 699                         // Tiles (fill in f->tiles[])
 700                         for(u16 j=0; j<6; j++){
 701                                 // Texture
 702                                 f->tiles[j].texture = tsrc->getTexture(
 703                                                 tiledef[j].name,
 704                                                 &f->tiles[j].texture_id);
 705                                 // Alpha
 706                                 f->tiles[j].alpha = f->alpha;
 707                                 // Material type
 708                                 f->tiles[j].material_type = material_type;
 709                                 // Material flags
 710                                 f->tiles[j].material_flags = 0;
 711                                 if(f->backface_culling)
 712                                         f->tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
 713                                 if(tiledef[j].animation.type == TAT_VERTICAL_FRAMES)
 714                                         f->tiles[j].material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
 715                                 // Animation parameters
 716                                 if(f->tiles[j].material_flags &
 717                                                 MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES)
 718                                 {
 719                                         // Get texture size to determine frame count by
 720                                         // aspect ratio
 721                                         v2u32 size = f->tiles[j].texture->getOriginalSize();
 722                                         int frame_height = (float)size.X /
 723                                                         (float)tiledef[j].animation.aspect_w *
 724                                                         (float)tiledef[j].animation.aspect_h;
 725                                         int frame_count = size.Y / frame_height;
 726                                         int frame_length_ms = 1000.0 *
 727                                                         tiledef[j].animation.length / frame_count;
 728                                         f->tiles[j].animation_frame_count = frame_count;
 729                                         f->tiles[j].animation_frame_length_ms = frame_length_ms;
 730
 731                                         // If there are no frames for an animation, switch
 732                                         // animation off (so that having specified an animation
 733                                         // for something but not using it in the texture pack
 734                                         // gives no overhead)
 735                                         if(frame_count == 1){
 736                                                 f->tiles[j].material_flags &=
 737                                                                 ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
 738                                         }
 739                                 }
 740                         }
 741                         // Special tiles (fill in f->special_tiles[])
 742                         for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
 743                                 // Texture
 744                                 f->special_tiles[j].texture = tsrc->getTexture(
 745                                                 f->tiledef_special[j].name,
 746                                                 &f->special_tiles[j].texture_id);
 747                                 // Alpha
 748                                 f->special_tiles[j].alpha = f->alpha;
 749                                 // Material type
 750                                 f->special_tiles[j].material_type = material_type;
 751                                 // Material flags
 752                                 f->special_tiles[j].material_flags = 0;
 753                                 if(f->tiledef_special[j].backface_culling)
 754                                         f->special_tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
 755                                 if(f->tiledef_special[j].animation.type == TAT_VERTICAL_FRAMES)
 756                                         f->special_tiles[j].material_flags |= MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
 757                                 // Animation parameters
 758                                 if(f->special_tiles[j].material_flags &
 759                                                 MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES)
 760                                 {
 761                                         // Get texture size to determine frame count by
 762                                         // aspect ratio
 763                                         v2u32 size = f->special_tiles[j].texture->getOriginalSize();
 764                                         int frame_height = (float)size.X /
 765                                                         (float)f->tiledef_special[j].animation.aspect_w *
 766                                                         (float)f->tiledef_special[j].animation.aspect_h;
 767                                         int frame_count = size.Y / frame_height;
 768                                         int frame_length_ms = 1000.0 *
 769                                                         f->tiledef_special[j].animation.length / frame_count;
 770                                         f->special_tiles[j].animation_frame_count = frame_count;
 771                                         f->special_tiles[j].animation_frame_length_ms = frame_length_ms;
 772
 773                                         // If there are no frames for an animation, switch
 774                                         // animation off (so that having specified an animation
 775                                         // for something but not using it in the texture pack
 776                                         // gives no overhead)
 777                                         if(frame_count == 1){
 778                                                 f->special_tiles[j].material_flags &=
 779                                                                 ~MATERIAL_FLAG_ANIMATION_VERTICAL_FRAMES;
 780                                         }
 781                                 }
 782                         }
 783                 }
 784 #endif
 785         }
 786         void serialize(std::ostream &os, u16 protocol_version)
 787         {
 788                 writeU8(os, 1); // version
 789                 u16 count = 0;
 790                 std::ostringstream os2(std::ios::binary);
 791                 for(u32 i=0; i<m_content_features.size(); i++)
 792                 {
 793                         if(i == CONTENT_IGNORE || i == CONTENT_AIR
 794                                         || i == CONTENT_UNKNOWN)
 795                                 continue;
 796                         ContentFeatures *f = &m_content_features[i];
 797                         if(f->name == "")
 798                                 continue;
 799                         writeU16(os2, i);
 800                         // Wrap it in a string to allow different lengths without
 801                         // strict version incompatibilities
 802                         std::ostringstream wrapper_os(std::ios::binary);
 803                         f->serialize(wrapper_os, protocol_version);
 804                         os2<<serializeString(wrapper_os.str());
 805
 806                         assert(count + 1 > count); // must not overflow
 807                         count++;
 808                 }
 809                 writeU16(os, count);
 810                 os<<serializeLongString(os2.str());
 811         }
 812         void deSerialize(std::istream &is)
 813         {
 814                 clear();
 815                 int version = readU8(is);
 816                 if(version != 1)
 817                         throw SerializationError("unsupported NodeDefinitionManager version");
 818                 u16 count = readU16(is);
 819                 std::istringstream is2(deSerializeLongString(is), std::ios::binary);
 820                 ContentFeatures f;
 821                 for(u16 n=0; n<count; n++){
 822                         u16 i = readU16(is2);
 823
 824                         // Read it from the string wrapper
 825                         std::string wrapper = deSerializeString(is2);
 826                         std::istringstream wrapper_is(wrapper, std::ios::binary);
 827                         f.deSerialize(wrapper_is);
 828
 829                         // Check error conditions
 830                         if(i == CONTENT_IGNORE || i == CONTENT_AIR
 831                                         || i == CONTENT_UNKNOWN){
 832                                 infostream<<"NodeDefManager::deSerialize(): WARNING: "
 833                                         <<"not changing builtin node "<<i
 834                                         <<std::endl;
 835                                 continue;
 836                         }
 837                         if(f.name == ""){
 838                                 infostream<<"NodeDefManager::deSerialize(): WARNING: "
 839                                         <<"received empty name"<<std::endl;
 840                                 continue;
 841                         }
 842                         u16 existing_id;
 843                         bool found = m_name_id_mapping.getId(f.name, existing_id);  // ignore aliases
 844                         if(found && i != existing_id){
 845                                 infostream<<"NodeDefManager::deSerialize(): WARNING: "
 846                                         <<"already defined with different ID: "
 847                                         <<f.name<<std::endl;
 848                                 continue;
 849                         }
 850
 851                         // All is ok, add node definition with the requested ID
 852                         if(i >= m_content_features.size())
 853                                 m_content_features.resize((u32)(i) + 1);
 854                         m_content_features[i] = f;
 855                         addNameIdMapping(i, f.name);
 856                         verbosestream<<"deserialized "<<f.name<<std::endl;
 857                 }
 858         }
 859 private:
 860         void addNameIdMapping(content_t i, std::string name)
 861         {
 862                 m_name_id_mapping.set(i, name);
 863                 m_name_id_mapping_with_aliases.insert(std::make_pair(name, i));
 864         }
 865 private:
 866         // Features indexed by id
 867         std::vector<ContentFeatures> m_content_features;
 868         // A mapping for fast converting back and forth between names and ids
 869         NameIdMapping m_name_id_mapping;
 870         // Like m_name_id_mapping, but only from names to ids, and includes
 871         // item aliases too. Updated by updateAliases()
 872         // Note: Not serialized.
 873         std::map<std::string, content_t> m_name_id_mapping_with_aliases;
 874         // A mapping from groups to a list of content_ts (and their levels)
 875         // that belong to it.  Necessary for a direct lookup in getIds().
 876         // Note: Not serialized.
 877         std::map<std::string, GroupItems> m_group_to_items;
 878         // Next possibly free id
 879         content_t m_next_id;
 880 };
 881
 882 IWritableNodeDefManager* createNodeDefManager()
 883 {
 884         return new CNodeDefManager();
 885 }
 886
 887 /*
 888         Serialization of old ContentFeatures formats
 889 */
 890
 891 void ContentFeatures::serializeOld(std::ostream &os, u16 protocol_version)
 892 {
 893         if(protocol_version == 13)
 894         {
 895                 writeU8(os, 5); // version
 896                 os<<serializeString(name);
 897                 writeU16(os, groups.size());
 898                 for(ItemGroupList::const_iterator
 899                                 i = groups.begin(); i != groups.end(); i++){
 900                         os<<serializeString(i->first);
 901                         writeS16(os, i->second);
 902                 }
 903                 writeU8(os, drawtype);
 904                 writeF1000(os, visual_scale);
 905                 writeU8(os, 6);
 906                 for(u32 i=0; i<6; i++)
 907                         tiledef[i].serialize(os, protocol_version);
 908                 writeU8(os, CF_SPECIAL_COUNT);
 909                 for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
 910                         tiledef_special[i].serialize(os, protocol_version);
 911                 }
 912                 writeU8(os, alpha);
 913                 writeU8(os, post_effect_color.getAlpha());
 914                 writeU8(os, post_effect_color.getRed());
 915                 writeU8(os, post_effect_color.getGreen());
 916                 writeU8(os, post_effect_color.getBlue());
 917                 writeU8(os, param_type);
 918                 writeU8(os, param_type_2);
 919                 writeU8(os, is_ground_content);
 920                 writeU8(os, light_propagates);
 921                 writeU8(os, sunlight_propagates);
 922                 writeU8(os, walkable);
 923                 writeU8(os, pointable);
 924                 writeU8(os, diggable);
 925                 writeU8(os, climbable);
 926                 writeU8(os, buildable_to);
 927                 os<<serializeString(""); // legacy: used to be metadata_name
 928                 writeU8(os, liquid_type);
 929                 os<<serializeString(liquid_alternative_flowing);
 930                 os<<serializeString(liquid_alternative_source);
 931                 writeU8(os, liquid_viscosity);
 932                 writeU8(os, light_source);
 933                 writeU32(os, damage_per_second);
 934                 node_box.serialize(os, protocol_version);
 935                 selection_box.serialize(os, protocol_version);
 936                 writeU8(os, legacy_facedir_simple);
 937                 writeU8(os, legacy_wallmounted);
 938                 serializeSimpleSoundSpec(sound_footstep, os);
 939                 serializeSimpleSoundSpec(sound_dig, os);
 940                 serializeSimpleSoundSpec(sound_dug, os);
 941         }
 942         else
 943         {
 944                 throw SerializationError("ContentFeatures::serialize(): Unsupported version requested");
 945         }
 946 }
 947
 948 void ContentFeatures::deSerializeOld(std::istream &is, int version)
 949 {
 950         if(version == 5) // In PROTOCOL_VERSION 13
 951         {
 952                 name = deSerializeString(is);
 953                 groups.clear();
 954                 u32 groups_size = readU16(is);
 955                 for(u32 i=0; i<groups_size; i++){
 956                         std::string name = deSerializeString(is);
 957                         int value = readS16(is);
 958                         groups[name] = value;
 959                 }
 960                 drawtype = (enum NodeDrawType)readU8(is);
 961                 visual_scale = readF1000(is);
 962                 if(readU8(is) != 6)
 963                         throw SerializationError("unsupported tile count");
 964                 for(u32 i=0; i<6; i++)
 965                         tiledef[i].deSerialize(is);
 966                 if(readU8(is) != CF_SPECIAL_COUNT)
 967                         throw SerializationError("unsupported CF_SPECIAL_COUNT");
 968                 for(u32 i=0; i<CF_SPECIAL_COUNT; i++)
 969                         tiledef_special[i].deSerialize(is);
 970                 alpha = readU8(is);
 971                 post_effect_color.setAlpha(readU8(is));
 972                 post_effect_color.setRed(readU8(is));
 973                 post_effect_color.setGreen(readU8(is));
 974                 post_effect_color.setBlue(readU8(is));
 975                 param_type = (enum ContentParamType)readU8(is);
 976                 param_type_2 = (enum ContentParamType2)readU8(is);
 977                 is_ground_content = readU8(is);
 978                 light_propagates = readU8(is);
 979                 sunlight_propagates = readU8(is);
 980                 walkable = readU8(is);
 981                 pointable = readU8(is);
 982                 diggable = readU8(is);
 983                 climbable = readU8(is);
 984                 buildable_to = readU8(is);
 985                 deSerializeString(is); // legacy: used to be metadata_name
 986                 liquid_type = (enum LiquidType)readU8(is);
 987                 liquid_alternative_flowing = deSerializeString(is);
 988                 liquid_alternative_source = deSerializeString(is);
 989                 liquid_viscosity = readU8(is);
 990                 light_source = readU8(is);
 991                 damage_per_second = readU32(is);
 992                 node_box.deSerialize(is);
 993                 selection_box.deSerialize(is);
 994                 legacy_facedir_simple = readU8(is);
 995                 legacy_wallmounted = readU8(is);
 996                 deSerializeSimpleSoundSpec(sound_footstep, is);
 997                 deSerializeSimpleSoundSpec(sound_dig, is);
 998                 deSerializeSimpleSoundSpec(sound_dug, is);
 999         }
1000         else
1001         {
1002                 throw SerializationError("unsupported ContentFeatures version");
1003         }
1004 }
1005