src/nodedef.cpp

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 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 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.
   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 General Public License for more details.
  14
  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.
  18 */
  19
  20 #include "nodedef.h"
  21
  22 #include "main.h" // For g_settings
  23 #include "nodemetadata.h"
  24 #ifndef SERVER
  25 #include "tile.h"
  26 #endif
  27 #include "log.h"
  28 #include "settings.h"
  29 #include "nameidmapping.h"
  30
  31 /*
  32         NodeBox
  33 */
  34
  35 void NodeBox::serialize(std::ostream &os) const
  36 {
  37         writeU8(os, 0); // version
  38         writeU8(os, type);
  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);
  47 }
  48
  49 void NodeBox::deSerialize(std::istream &is)
  50 {
  51         int version = readU8(is);
  52         if(version != 0)
  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);
  63 }
  64
  65 /*
  66         MaterialSpec
  67 */
  68
  69 void MaterialSpec::serialize(std::ostream &os) const
  70 {
  71         os<<serializeString(tname);
  72         writeU8(os, backface_culling);
  73 }
  74
  75 void MaterialSpec::deSerialize(std::istream &is)
  76 {
  77         tname = deSerializeString(is);
  78         backface_culling = readU8(is);
  79 }
  80
  81 /*
  82         ContentFeatures
  83 */
  84
  85 ContentFeatures::ContentFeatures()
  86 {
  87         reset();
  88 }
  89
  90 ContentFeatures::~ContentFeatures()
  91 {
  92 #ifndef SERVER
  93         for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
  94                 delete special_materials[j];
  95                 delete special_aps[j];
  96         }
  97 #endif
  98 }
  99
 100 void ContentFeatures::reset()
 101 {
 102         /*
 103                 Cached stuff
 104         */
 105 #ifndef SERVER
 106         inventory_texture = NULL;
 107
 108         for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
 109                 special_materials[j] = NULL;
 110                 special_aps[j] = NULL;
 111         }
 112         solidness = 2;
 113         visual_solidness = 0;
 114         backface_culling = true;
 115 #endif
 116         used_texturenames.clear();
 117         /*
 118                 Actual data
 119
 120                 NOTE: Most of this is always overridden by the default values given
 121                       in builtin.lua
 122         */
 123         name = "";
 124         drawtype = NDT_NORMAL;
 125         visual_scale = 1.0;
 126         for(u32 i=0; i<6; i++)
 127                 tname_tiles[i] = "";
 128         for(u16 j=0; j<CF_SPECIAL_COUNT; j++)
 129                 mspec_special[j] = MaterialSpec();
 130         tname_inventory = "";
 131         alpha = 255;
 132         post_effect_color = video::SColor(0, 0, 0, 0);
 133         param_type = CPT_NONE;
 134         is_ground_content = false;
 135         light_propagates = false;
 136         sunlight_propagates = false;
 137         walkable = true;
 138         pointable = true;
 139         diggable = true;
 140         climbable = false;
 141         buildable_to = false;
 142         wall_mounted = false;
 143         often_contains_mineral = false;
 144         dug_item = "";
 145         extra_dug_item = "";
 146         extra_dug_item_rarity = 2;
 147         metadata_name = "";
 148         liquid_type = LIQUID_NONE;
 149         liquid_alternative_flowing = "";
 150         liquid_alternative_source = "";
 151         liquid_viscosity = 0;
 152         light_source = 0;
 153         damage_per_second = 0;
 154         selection_box = NodeBox();
 155         material = MaterialProperties();
 156         cookresult_item = ""; // Cannot be cooked
 157         furnace_cooktime = 3.0;
 158         furnace_burntime = -1.0; // Cannot be burned
 159 }
 160
 161 void ContentFeatures::serialize(std::ostream &os)
 162 {
 163         writeU8(os, 0); // version
 164         os<<serializeString(name);
 165         writeU8(os, drawtype);
 166         writeF1000(os, visual_scale);
 167         writeU8(os, 6);
 168         for(u32 i=0; i<6; i++)
 169                 os<<serializeString(tname_tiles[i]);
 170         os<<serializeString(tname_inventory);
 171         writeU8(os, CF_SPECIAL_COUNT);
 172         for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
 173                 mspec_special[i].serialize(os);
 174         }
 175         writeU8(os, alpha);
 176         writeU8(os, post_effect_color.getAlpha());
 177         writeU8(os, post_effect_color.getRed());
 178         writeU8(os, post_effect_color.getGreen());
 179         writeU8(os, post_effect_color.getBlue());
 180         writeU8(os, param_type);
 181         writeU8(os, is_ground_content);
 182         writeU8(os, light_propagates);
 183         writeU8(os, sunlight_propagates);
 184         writeU8(os, walkable);
 185         writeU8(os, pointable);
 186         writeU8(os, diggable);
 187         writeU8(os, climbable);
 188         writeU8(os, buildable_to);
 189         writeU8(os, wall_mounted);
 190         writeU8(os, often_contains_mineral);
 191         os<<serializeString(dug_item);
 192         os<<serializeString(extra_dug_item);
 193         writeS32(os, extra_dug_item_rarity);
 194         os<<serializeString(metadata_name);
 195         writeU8(os, liquid_type);
 196         os<<serializeString(liquid_alternative_flowing);
 197         os<<serializeString(liquid_alternative_source);
 198         writeU8(os, liquid_viscosity);
 199         writeU8(os, light_source);
 200         writeU32(os, damage_per_second);
 201         selection_box.serialize(os);
 202         material.serialize(os);
 203         os<<serializeString(cookresult_item);
 204         writeF1000(os, furnace_cooktime);
 205         writeF1000(os, furnace_burntime);
 206 }
 207
 208 void ContentFeatures::deSerialize(std::istream &is, IGameDef *gamedef)
 209 {
 210         int version = readU8(is);
 211         if(version != 0)
 212                 throw SerializationError("unsupported ContentFeatures version");
 213         name = deSerializeString(is);
 214         drawtype = (enum NodeDrawType)readU8(is);
 215         visual_scale = readF1000(is);
 216         if(readU8(is) != 6)
 217                 throw SerializationError("unsupported tile count");
 218         for(u32 i=0; i<6; i++)
 219                 tname_tiles[i] = deSerializeString(is);
 220         tname_inventory = deSerializeString(is);
 221         if(readU8(is) != CF_SPECIAL_COUNT)
 222                 throw SerializationError("unsupported CF_SPECIAL_COUNT");
 223         for(u32 i=0; i<CF_SPECIAL_COUNT; i++){
 224                 mspec_special[i].deSerialize(is);
 225         }
 226         alpha = readU8(is);
 227         post_effect_color.setAlpha(readU8(is));
 228         post_effect_color.setRed(readU8(is));
 229         post_effect_color.setGreen(readU8(is));
 230         post_effect_color.setBlue(readU8(is));
 231         param_type = (enum ContentParamType)readU8(is);
 232         is_ground_content = readU8(is);
 233         light_propagates = readU8(is);
 234         sunlight_propagates = readU8(is);
 235         walkable = readU8(is);
 236         pointable = readU8(is);
 237         diggable = readU8(is);
 238         climbable = readU8(is);
 239         buildable_to = readU8(is);
 240         wall_mounted = readU8(is);
 241         often_contains_mineral = readU8(is);
 242         dug_item = deSerializeString(is);
 243         extra_dug_item = deSerializeString(is);
 244         extra_dug_item_rarity = readS32(is);
 245         metadata_name = deSerializeString(is);
 246         liquid_type = (enum LiquidType)readU8(is);
 247         liquid_alternative_flowing = deSerializeString(is);
 248         liquid_alternative_source = deSerializeString(is);
 249         liquid_viscosity = readU8(is);
 250         light_source = readU8(is);
 251         damage_per_second = readU32(is);
 252         selection_box.deSerialize(is);
 253         material.deSerialize(is);
 254         cookresult_item = deSerializeString(is);
 255         furnace_cooktime = readF1000(is);
 256         furnace_burntime = readF1000(is);
 257 }
 258
 259 void ContentFeatures::setTexture(u16 i, std::string name)
 260 {
 261         used_texturenames.insert(name);
 262         tname_tiles[i] = name;
 263         if(tname_inventory == "")
 264                 tname_inventory = name;
 265 }
 266
 267 void ContentFeatures::setAllTextures(std::string name)
 268 {
 269         for(u16 i=0; i<6; i++)
 270                 setTexture(i, name);
 271         // Force inventory texture too
 272         setInventoryTexture(name);
 273 }
 274
 275 void ContentFeatures::setSpecialMaterial(u16 i, const MaterialSpec &mspec)
 276 {
 277         assert(i < CF_SPECIAL_COUNT);
 278         mspec_special[i] = mspec;
 279 }
 280
 281 void ContentFeatures::setInventoryTexture(std::string imgname)
 282 {
 283         tname_inventory = imgname + "^[forcesingle";
 284 }
 285
 286 void ContentFeatures::setInventoryTextureCube(std::string top,
 287                 std::string left, std::string right)
 288 {
 289         str_replace_char(top, '^', '&');
 290         str_replace_char(left, '^', '&');
 291         str_replace_char(right, '^', '&');
 292
 293         std::string imgname_full;
 294         imgname_full += "[inventorycube{";
 295         imgname_full += top;
 296         imgname_full += "{";
 297         imgname_full += left;
 298         imgname_full += "{";
 299         imgname_full += right;
 300         tname_inventory = imgname_full;
 301 }
 302
 303 /*
 304         CNodeDefManager
 305 */
 306
 307 class CNodeDefManager: public IWritableNodeDefManager
 308 {
 309 public:
 310         void clear()
 311         {
 312                 m_name_id_mapping.clear();
 313                 for(u16 i=0; i<=MAX_CONTENT; i++)
 314                 {
 315                         ContentFeatures &f = m_content_features[i];
 316                         f.reset(); // Reset to defaults
 317                         f.setAllTextures("unknown_block.png");
 318                 }
 319
 320                 // Set CONTENT_AIR
 321                 {
 322                         ContentFeatures f;
 323                         f.name = "air";
 324                         f.drawtype = NDT_AIRLIKE;
 325                         f.param_type = CPT_LIGHT;
 326                         f.light_propagates = true;
 327                         f.sunlight_propagates = true;
 328                         f.walkable = false;
 329                         f.pointable = false;
 330                         f.diggable = false;
 331                         f.buildable_to = true;
 332                         // Insert directly into containers
 333                         content_t c = CONTENT_AIR;
 334                         m_content_features[c] = f;
 335                         m_name_id_mapping.set(c, f.name);
 336                 }
 337                 // Set CONTENT_IGNORE
 338                 {
 339                         ContentFeatures f;
 340                         f.name = "ignore";
 341                         f.drawtype = NDT_AIRLIKE;
 342                         f.param_type = CPT_NONE;
 343                         f.light_propagates = false;
 344                         f.sunlight_propagates = false;
 345                         f.walkable = false;
 346                         f.pointable = false;
 347                         f.diggable = false;
 348                         // A way to remove accidental CONTENT_IGNOREs
 349                         f.buildable_to = true;
 350                         // Insert directly into containers
 351                         content_t c = CONTENT_IGNORE;
 352                         m_content_features[c] = f;
 353                         m_name_id_mapping.set(c, f.name);
 354                 }
 355         }
 356         // CONTENT_IGNORE = not found
 357         content_t getFreeId(bool require_full_param2)
 358         {
 359                 // If allowed, first search in the large 4-byte-param2 pool
 360                 if(!require_full_param2){
 361                         for(u16 i=0x800; i<=0xfff; i++){
 362                                 const ContentFeatures &f = m_content_features[i];
 363                                 if(f.name == "")
 364                                         return i;
 365                         }
 366                 }
 367                 // Then search from the small 8-byte-param2 pool
 368                 for(u16 i=0; i<=125; i++){
 369                         const ContentFeatures &f = m_content_features[i];
 370                         if(f.name == "")
 371                                 return i;
 372                 }
 373                 return CONTENT_IGNORE;
 374         }
 375         CNodeDefManager()
 376         {
 377                 clear();
 378         }
 379         virtual ~CNodeDefManager()
 380         {
 381         }
 382         virtual IWritableNodeDefManager* clone()
 383         {
 384                 CNodeDefManager *mgr = new CNodeDefManager();
 385                 for(u16 i=0; i<=MAX_CONTENT; i++)
 386                 {
 387                         mgr->set(i, get(i));
 388                 }
 389                 return mgr;
 390         }
 391         virtual const ContentFeatures& get(content_t c) const
 392         {
 393                 assert(c <= MAX_CONTENT);
 394                 return m_content_features[c];
 395         }
 396         virtual const ContentFeatures& get(const MapNode &n) const
 397         {
 398                 return get(n.getContent());
 399         }
 400         virtual bool getId(const std::string &name, content_t &result) const
 401         {
 402                 return m_name_id_mapping.getId(name, result);
 403         }
 404         virtual content_t getId(const std::string &name) const
 405         {
 406                 content_t id = CONTENT_IGNORE;
 407                 getId(name, id);
 408                 return id;
 409         }
 410         virtual const ContentFeatures& get(const std::string &name) const
 411         {
 412                 content_t id = CONTENT_IGNORE;
 413                 getId(name, id);
 414                 return get(id);
 415         }
 416         // IWritableNodeDefManager
 417         virtual void set(content_t c, const ContentFeatures &def)
 418         {
 419                 infostream<<"registerNode: registering content id \""<<c
 420                                 <<"\": name=\""<<def.name<<"\""<<std::endl;
 421                 assert(c <= MAX_CONTENT);
 422                 // Don't allow redefining CONTENT_IGNORE (but allow air)
 423                 if(def.name == "ignore" || c == CONTENT_IGNORE){
 424                         infostream<<"registerNode: WARNING: Ignoring "
 425                                         <<"CONTENT_IGNORE redefinition"<<std::endl;
 426                         return;
 427                 }
 428                 // Check that the special contents are not redefined as different id
 429                 // because it would mess up everything
 430                 if((def.name == "ignore" && c != CONTENT_IGNORE) ||
 431                         (def.name == "air" && c != CONTENT_AIR)){
 432                         errorstream<<"registerNode: IGNORING ERROR: "
 433                                         <<"trying to register built-in type \""
 434                                         <<def.name<<"\" as different id"<<std::endl;
 435                         return;
 436                 }
 437                 m_content_features[c] = def;
 438                 if(def.name != "")
 439                         m_name_id_mapping.set(c, def.name);
 440         }
 441         virtual content_t set(const std::string &name,
 442                         const ContentFeatures &def)
 443         {
 444                 assert(name == def.name);
 445                 u16 id = CONTENT_IGNORE;
 446                 bool found = m_name_id_mapping.getId(name, id);
 447                 if(!found){
 448                         // Determine if full param2 is required
 449                         bool require_full_param2 = (
 450                                 def.liquid_type == LIQUID_FLOWING
 451                                 ||
 452                                 def.drawtype == NDT_FLOWINGLIQUID
 453                                 ||
 454                                 def.drawtype == NDT_TORCHLIKE
 455                                 ||
 456                                 def.drawtype == NDT_SIGNLIKE
 457                         );
 458                         // Get some id
 459                         id = getFreeId(require_full_param2);
 460                         if(id == CONTENT_IGNORE)
 461                                 return CONTENT_IGNORE;
 462                         if(name != "")
 463                                 m_name_id_mapping.set(id, name);
 464                 }
 465                 set(id, def);
 466                 return id;
 467         }
 468         virtual content_t allocateDummy(const std::string &name)
 469         {
 470                 assert(name != "");
 471                 ContentFeatures f;
 472                 f.name = name;
 473                 f.setAllTextures("unknown_block.png");
 474                 return set(name, f);
 475         }
 476         virtual void updateTextures(ITextureSource *tsrc)
 477         {
 478 #ifndef SERVER
 479                 infostream<<"CNodeDefManager::updateTextures(): Updating "
 480                                 <<"textures in node definitions"<<std::endl;
 481
 482                 bool new_style_water = g_settings->getBool("new_style_water");
 483                 bool new_style_leaves = g_settings->getBool("new_style_leaves");
 484                 bool opaque_water = g_settings->getBool("opaque_water");
 485
 486                 for(u16 i=0; i<=MAX_CONTENT; i++)
 487                 {
 488                         ContentFeatures *f = &m_content_features[i];
 489
 490                         switch(f->drawtype){
 491                         default:
 492                         case NDT_NORMAL:
 493                                 f->solidness = 2;
 494                                 break;
 495                         case NDT_AIRLIKE:
 496                                 f->solidness = 0;
 497                                 break;
 498                         case NDT_LIQUID:
 499                                 assert(f->liquid_type == LIQUID_SOURCE);
 500                                 if(opaque_water)
 501                                         f->alpha = 255;
 502                                 if(new_style_water){
 503                                         f->solidness = 0;
 504                                 } else {
 505                                         f->solidness = 1;
 506                                         if(f->alpha == 255)
 507                                                 f->solidness = 2;
 508                                 }
 509                                 break;
 510                         case NDT_FLOWINGLIQUID:
 511                                 assert(f->liquid_type == LIQUID_FLOWING);
 512                                 f->solidness = 0;
 513                                 if(opaque_water)
 514                                         f->alpha = 255;
 515                                 break;
 516                         case NDT_GLASSLIKE:
 517                                 f->solidness = 0;
 518                                 f->visual_solidness = 1;
 519                                 break;
 520                         case NDT_ALLFACES:
 521                                 f->solidness = 0;
 522                                 f->visual_solidness = 1;
 523                                 break;
 524                         case NDT_ALLFACES_OPTIONAL:
 525                                 if(new_style_leaves){
 526                                         f->drawtype = NDT_ALLFACES;
 527                                         f->solidness = 0;
 528                                         f->visual_solidness = 1;
 529                                 } else {
 530                                         f->drawtype = NDT_NORMAL;
 531                                         f->solidness = 1;
 532                                         for(u32 i=0; i<6; i++){
 533                                                 f->tname_tiles[i] = f->tname_tiles[i]
 534                                                                 + std::string("^[noalpha");
 535                                         }
 536                                 }
 537                                 break;
 538                         case NDT_TORCHLIKE:
 539                         case NDT_SIGNLIKE:
 540                         case NDT_PLANTLIKE:
 541                         case NDT_FENCELIKE:
 542                         case NDT_RAILLIKE:
 543                                 f->solidness = 0;
 544                                 break;
 545                         }
 546
 547                         // Inventory texture
 548                         if(f->tname_inventory != "")
 549                                 f->inventory_texture = tsrc->getTextureRaw(f->tname_inventory);
 550                         else
 551                                 f->inventory_texture = NULL;
 552                         // Tile textures
 553                         for(u16 j=0; j<6; j++){
 554                                 if(f->tname_tiles[j] == "")
 555                                         continue;
 556                                 f->tiles[j].texture = tsrc->getTexture(f->tname_tiles[j]);
 557                                 f->tiles[j].alpha = f->alpha;
 558                                 if(f->alpha == 255)
 559                                         f->tiles[j].material_type = MATERIAL_ALPHA_SIMPLE;
 560                                 else
 561                                         f->tiles[j].material_type = MATERIAL_ALPHA_VERTEX;
 562                                 if(f->backface_culling)
 563                                         f->tiles[j].material_flags |= MATERIAL_FLAG_BACKFACE_CULLING;
 564                                 else
 565                                         f->tiles[j].material_flags &= ~MATERIAL_FLAG_BACKFACE_CULLING;
 566                         }
 567                         // Special textures
 568                         for(u16 j=0; j<CF_SPECIAL_COUNT; j++){
 569                                 // Remove all stuff
 570                                 if(f->special_aps[j]){
 571                                         delete f->special_aps[j];
 572                                         f->special_aps[j] = NULL;
 573                                 }
 574                                 if(f->special_materials[j]){
 575                                         delete f->special_materials[j];
 576                                         f->special_materials[j] = NULL;
 577                                 }
 578                                 // Skip if should not exist
 579                                 if(f->mspec_special[j].tname == "")
 580                                         continue;
 581                                 // Create all stuff
 582                                 f->special_aps[j] = new AtlasPointer(
 583                                                 tsrc->getTexture(f->mspec_special[j].tname));
 584                                 f->special_materials[j] = new video::SMaterial;
 585                                 f->special_materials[j]->setFlag(video::EMF_LIGHTING, false);
 586                                 f->special_materials[j]->setFlag(video::EMF_BACK_FACE_CULLING,
 587                                                 f->mspec_special[j].backface_culling);
 588                                 f->special_materials[j]->setFlag(video::EMF_BILINEAR_FILTER, false);
 589                                 f->special_materials[j]->setFlag(video::EMF_FOG_ENABLE, true);
 590                                 f->special_materials[j]->setTexture(0, f->special_aps[j]->atlas);
 591                                 if(f->alpha != 255)
 592                                         f->special_materials[j]->MaterialType =
 593                                                         video::EMT_TRANSPARENT_VERTEX_ALPHA;
 594                         }
 595                 }
 596 #endif
 597         }
 598         void serialize(std::ostream &os)
 599         {
 600                 u16 count = 0;
 601                 std::ostringstream tmp_os(std::ios::binary);
 602                 for(u16 i=0; i<=MAX_CONTENT; i++)
 603                 {
 604                         if(i == CONTENT_IGNORE || i == CONTENT_AIR)
 605                                 continue;
 606                         ContentFeatures *f = &m_content_features[i];
 607                         if(f->name == "")
 608                                 continue;
 609                         writeU16(tmp_os, i);
 610                         f->serialize(tmp_os);
 611                         count++;
 612                 }
 613                 writeU16(os, count);
 614                 os<<serializeLongString(tmp_os.str());
 615         }
 616         void deSerialize(std::istream &is, IGameDef *gamedef)
 617         {
 618                 clear();
 619                 u16 count = readU16(is);
 620                 std::istringstream tmp_is(deSerializeLongString(is), std::ios::binary);
 621                 for(u16 n=0; n<count; n++){
 622                         u16 i = readU16(tmp_is);
 623                         if(i > MAX_CONTENT){
 624                                 errorstream<<"ContentFeatures::deSerialize(): "
 625                                                 <<"Too large content id: "<<i<<std::endl;
 626                                 continue;
 627                         }
 628                         /*// Do not deserialize special types
 629                         if(i == CONTENT_IGNORE || i == CONTENT_AIR)
 630                                 continue;*/
 631                         ContentFeatures *f = &m_content_features[i];
 632                         f->deSerialize(tmp_is, gamedef);
 633                         if(f->name != "")
 634                                 m_name_id_mapping.set(i, f->name);
 635                 }
 636         }
 637 private:
 638         ContentFeatures m_content_features[MAX_CONTENT+1];
 639         NameIdMapping m_name_id_mapping;
 640 };
 641
 642 IWritableNodeDefManager* createNodeDefManager()
 643 {
 644         return new CNodeDefManager();
 645 }
 646