src/itemdef.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2013 Kahrl <kahrl@gmx.net>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #include "itemdef.h"
  22
  23 #include "gamedef.h"
  24 #include "nodedef.h"
  25 #include "tool.h"
  26 #include "inventory.h"
  27 #ifndef SERVER
  28 #include "mapblock_mesh.h"
  29 #include "mesh.h"
  30 #include "tile.h"
  31 #endif
  32 #include "log.h"
  33 #include "main.h" // g_settings
  34 #include "settings.h"
  35 #include "util/serialize.h"
  36 #include "util/container.h"
  37 #include "util/thread.h"
  38 #include <map>
  39 #include <set>
  40
  41 /*
  42         ItemDefinition
  43 */
  44 ItemDefinition::ItemDefinition()
  45 {
  46         resetInitial();
  47 }
  48
  49 ItemDefinition::ItemDefinition(const ItemDefinition &def)
  50 {
  51         resetInitial();
  52         *this = def;
  53 }
  54
  55 ItemDefinition& ItemDefinition::operator=(const ItemDefinition &def)
  56 {
  57         if(this == &def)
  58                 return *this;
  59
  60         reset();
  61
  62         type = def.type;
  63         name = def.name;
  64         description = def.description;
  65         inventory_image = def.inventory_image;
  66         wield_image = def.wield_image;
  67         wield_scale = def.wield_scale;
  68         stack_max = def.stack_max;
  69         usable = def.usable;
  70         liquids_pointable = def.liquids_pointable;
  71         if(def.tool_capabilities)
  72         {
  73                 tool_capabilities = new ToolCapabilities(
  74                                 *def.tool_capabilities);
  75         }
  76         groups = def.groups;
  77         node_placement_prediction = def.node_placement_prediction;
  78         sound_place = def.sound_place;
  79         return *this;
  80 }
  81
  82 ItemDefinition::~ItemDefinition()
  83 {
  84         reset();
  85 }
  86
  87 void ItemDefinition::resetInitial()
  88 {
  89         // Initialize pointers to NULL so reset() does not delete undefined pointers
  90         tool_capabilities = NULL;
  91         reset();
  92 }
  93
  94 void ItemDefinition::reset()
  95 {
  96         type = ITEM_NONE;
  97         name = "";
  98         description = "";
  99         inventory_image = "";
 100         wield_image = "";
 101         wield_scale = v3f(1.0, 1.0, 1.0);
 102         stack_max = 99;
 103         usable = false;
 104         liquids_pointable = false;
 105         if(tool_capabilities)
 106         {
 107                 delete tool_capabilities;
 108                 tool_capabilities = NULL;
 109         }
 110         groups.clear();
 111         sound_place = SimpleSoundSpec();
 112
 113         node_placement_prediction = "";
 114 }
 115
 116 void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
 117 {
 118         if(protocol_version <= 17)
 119                 writeU8(os, 1); // version
 120         else
 121                 writeU8(os, 2); // version
 122         writeU8(os, type);
 123         os<<serializeString(name);
 124         os<<serializeString(description);
 125         os<<serializeString(inventory_image);
 126         os<<serializeString(wield_image);
 127         writeV3F1000(os, wield_scale);
 128         writeS16(os, stack_max);
 129         writeU8(os, usable);
 130         writeU8(os, liquids_pointable);
 131         std::string tool_capabilities_s = "";
 132         if(tool_capabilities){
 133                 std::ostringstream tmp_os(std::ios::binary);
 134                 tool_capabilities->serialize(tmp_os, protocol_version);
 135                 tool_capabilities_s = tmp_os.str();
 136         }
 137         os<<serializeString(tool_capabilities_s);
 138         writeU16(os, groups.size());
 139         for(std::map<std::string, int>::const_iterator
 140                         i = groups.begin(); i != groups.end(); i++){
 141                 os<<serializeString(i->first);
 142                 writeS16(os, i->second);
 143         }
 144         os<<serializeString(node_placement_prediction);
 145         if(protocol_version > 17){
 146                 //serializeSimpleSoundSpec(sound_place, os);
 147                 os<<serializeString(sound_place.name);
 148                 writeF1000(os, sound_place.gain);
 149         }
 150 }
 151
 152 void ItemDefinition::deSerialize(std::istream &is)
 153 {
 154         // Reset everything
 155         reset();
 156
 157         // Deserialize
 158         int version = readU8(is);
 159         if(version != 1 && version != 2)
 160                 throw SerializationError("unsupported ItemDefinition version");
 161         type = (enum ItemType)readU8(is);
 162         name = deSerializeString(is);
 163         description = deSerializeString(is);
 164         inventory_image = deSerializeString(is);
 165         wield_image = deSerializeString(is);
 166         wield_scale = readV3F1000(is);
 167         stack_max = readS16(is);
 168         usable = readU8(is);
 169         liquids_pointable = readU8(is);
 170         std::string tool_capabilities_s = deSerializeString(is);
 171         if(!tool_capabilities_s.empty())
 172         {
 173                 std::istringstream tmp_is(tool_capabilities_s, std::ios::binary);
 174                 tool_capabilities = new ToolCapabilities;
 175                 tool_capabilities->deSerialize(tmp_is);
 176         }
 177         groups.clear();
 178         u32 groups_size = readU16(is);
 179         for(u32 i=0; i<groups_size; i++){
 180                 std::string name = deSerializeString(is);
 181                 int value = readS16(is);
 182                 groups[name] = value;
 183         }
 184         if(version == 1){
 185                 // We cant be sure that node_placement_prediction is send in version 1
 186                 try{
 187                         node_placement_prediction = deSerializeString(is);
 188                 }catch(SerializationError &e) {};
 189                 // Set the old default sound
 190                 sound_place.name = "default_place_node";
 191                 sound_place.gain = 0.5;
 192         } else if(version == 2) {
 193                 node_placement_prediction = deSerializeString(is);
 194                 //deserializeSimpleSoundSpec(sound_place, is);
 195                 sound_place.name = deSerializeString(is);
 196                 sound_place.gain = readF1000(is);
 197         }
 198         // If you add anything here, insert it primarily inside the try-catch
 199         // block to not need to increase the version.
 200         try{
 201
 202         }catch(SerializationError &e) {};
 203 }
 204
 205 /*
 206         CItemDefManager
 207 */
 208
 209 // SUGG: Support chains of aliases?
 210
 211 class CItemDefManager: public IWritableItemDefManager
 212 {
 213 #ifndef SERVER
 214         struct ClientCached
 215         {
 216                 video::ITexture *inventory_texture;
 217                 scene::IMesh *wield_mesh;
 218
 219                 ClientCached():
 220                         inventory_texture(NULL),
 221                         wield_mesh(NULL)
 222                 {}
 223         };
 224 #endif
 225
 226 public:
 227         CItemDefManager()
 228         {
 229
 230 #ifndef SERVER
 231                 m_main_thread = get_current_thread_id();
 232 #endif
 233                 clear();
 234         }
 235         virtual ~CItemDefManager()
 236         {
 237 #ifndef SERVER
 238                 const std::list<ClientCached*> &values = m_clientcached.getValues();
 239                 for(std::list<ClientCached*>::const_iterator
 240                                 i = values.begin(); i != values.end(); ++i)
 241                 {
 242                         ClientCached *cc = *i;
 243                         if (cc->wield_mesh)
 244                                 cc->wield_mesh->drop();
 245                         delete cc;
 246                 }
 247
 248 #endif
 249                 for (std::map<std::string, ItemDefinition*>::iterator iter =
 250                                 m_item_definitions.begin(); iter != m_item_definitions.end();
 251                                 iter ++) {
 252                         delete iter->second;
 253                 }
 254                 m_item_definitions.clear();
 255         }
 256         virtual const ItemDefinition& get(const std::string &name_) const
 257         {
 258                 // Convert name according to possible alias
 259                 std::string name = getAlias(name_);
 260                 // Get the definition
 261                 std::map<std::string, ItemDefinition*>::const_iterator i;
 262                 i = m_item_definitions.find(name);
 263                 if(i == m_item_definitions.end())
 264                         i = m_item_definitions.find("unknown");
 265                 assert(i != m_item_definitions.end());
 266                 return *(i->second);
 267         }
 268         virtual std::string getAlias(const std::string &name) const
 269         {
 270                 std::map<std::string, std::string>::const_iterator i;
 271                 i = m_aliases.find(name);
 272                 if(i != m_aliases.end())
 273                         return i->second;
 274                 return name;
 275         }
 276         virtual std::set<std::string> getAll() const
 277         {
 278                 std::set<std::string> result;
 279                 for(std::map<std::string, ItemDefinition*>::const_iterator
 280                                 i = m_item_definitions.begin();
 281                                 i != m_item_definitions.end(); i++)
 282                 {
 283                         result.insert(i->first);
 284                 }
 285                 for(std::map<std::string, std::string>::const_iterator
 286                                 i = m_aliases.begin();
 287                                 i != m_aliases.end(); i++)
 288                 {
 289                         result.insert(i->first);
 290                 }
 291                 return result;
 292         }
 293         virtual bool isKnown(const std::string &name_) const
 294         {
 295                 // Convert name according to possible alias
 296                 std::string name = getAlias(name_);
 297                 // Get the definition
 298                 std::map<std::string, ItemDefinition*>::const_iterator i;
 299                 return m_item_definitions.find(name) != m_item_definitions.end();
 300         }
 301 #ifndef SERVER
 302 public:
 303         ClientCached* createClientCachedDirect(const std::string &name,
 304                         IGameDef *gamedef) const
 305         {
 306                 infostream<<"Lazily creating item texture and mesh for \""
 307                                 <<name<<"\""<<std::endl;
 308
 309                 // This is not thread-safe
 310                 assert(get_current_thread_id() == m_main_thread);
 311
 312                 // Skip if already in cache
 313                 ClientCached *cc = NULL;
 314                 m_clientcached.get(name, &cc);
 315                 if(cc)
 316                         return cc;
 317
 318                 ITextureSource *tsrc = gamedef->getTextureSource();
 319                 INodeDefManager *nodedef = gamedef->getNodeDefManager();
 320                 IrrlichtDevice *device = tsrc->getDevice();
 321                 video::IVideoDriver *driver = device->getVideoDriver();
 322                 const ItemDefinition *def = &get(name);
 323
 324                 // Create new ClientCached
 325                 cc = new ClientCached();
 326
 327                 bool need_node_mesh = false;
 328
 329                 // Create an inventory texture
 330                 cc->inventory_texture = NULL;
 331                 if(def->inventory_image != "")
 332                 {
 333                         cc->inventory_texture = tsrc->getTexture(def->inventory_image);
 334                 }
 335                 else if(def->type == ITEM_NODE)
 336                 {
 337                         need_node_mesh = true;
 338                 }
 339
 340                 // Create a wield mesh
 341                 assert(cc->wield_mesh == NULL);
 342                 if(def->type == ITEM_NODE && def->wield_image == "")
 343                 {
 344                         need_node_mesh = true;
 345                 }
 346                 else if(def->wield_image != "" || def->inventory_image != "")
 347                 {
 348                         // Extrude the wield image into a mesh
 349
 350                         std::string imagename;
 351                         if(def->wield_image != "")
 352                                 imagename = def->wield_image;
 353                         else
 354                                 imagename = def->inventory_image;
 355
 356                         cc->wield_mesh = createExtrudedMesh(
 357                                         tsrc->getTexture(imagename),
 358                                         driver,
 359                                         def->wield_scale * v3f(40.0, 40.0, 4.0));
 360                         if(cc->wield_mesh == NULL)
 361                         {
 362                                 infostream<<"ItemDefManager: WARNING: "
 363                                         <<"updateTexturesAndMeshes(): "
 364                                         <<"Unable to create extruded mesh for item "
 365                                         <<def->name<<std::endl;
 366                         }
 367                 }
 368
 369                 if(need_node_mesh)
 370                 {
 371                         /*
 372                                 Get node properties
 373                         */
 374                         content_t id = nodedef->getId(def->name);
 375                         const ContentFeatures &f = nodedef->get(id);
 376
 377                         u8 param1 = 0;
 378                         if(f.param_type == CPT_LIGHT)
 379                                 param1 = 0xee;
 380
 381                         /*
 382                                 Make a mesh from the node
 383                         */
 384                         MeshMakeData mesh_make_data(gamedef);
 385                         MapNode mesh_make_node(id, param1, 0);
 386                         mesh_make_data.fillSingleNode(&mesh_make_node);
 387                         MapBlockMesh mapblock_mesh(&mesh_make_data);
 388
 389                         scene::IMesh *node_mesh = mapblock_mesh.getMesh();
 390                         assert(node_mesh);
 391                         video::SColor c(255, 255, 255, 255);
 392                         if(g_settings->getBool("enable_shaders"))
 393                                 c = MapBlock_LightColor(255, 0xffff, decode_light(f.light_source));
 394                         setMeshColor(node_mesh, c);
 395
 396                         /*
 397                                 Scale and translate the mesh so it's a unit cube
 398                                 centered on the origin
 399                         */
 400                         scaleMesh(node_mesh, v3f(1.0/BS, 1.0/BS, 1.0/BS));
 401                         translateMesh(node_mesh, v3f(-1.0, -1.0, -1.0));
 402
 403                         /*
 404                                 Draw node mesh into a render target texture
 405                         */
 406                         if(cc->inventory_texture == NULL)
 407                         {
 408                                 TextureFromMeshParams params;
 409                                 params.mesh = node_mesh;
 410                                 params.dim.set(64, 64);
 411                                 params.rtt_texture_name = "INVENTORY_"
 412                                         + def->name + "_RTT";
 413                                 params.delete_texture_on_shutdown = true;
 414                                 params.camera_position.set(0, 1.0, -1.5);
 415                                 params.camera_position.rotateXZBy(45);
 416                                 params.camera_lookat.set(0, 0, 0);
 417                                 // Set orthogonal projection
 418                                 params.camera_projection_matrix.buildProjectionMatrixOrthoLH(
 419                                                 1.65, 1.65, 0, 100);
 420                                 params.ambient_light.set(1.0, 0.2, 0.2, 0.2);
 421                                 params.light_position.set(10, 100, -50);
 422                                 params.light_color.set(1.0, 0.5, 0.5, 0.5);
 423                                 params.light_radius = 1000;
 424
 425                                 cc->inventory_texture =
 426                                         tsrc->generateTextureFromMesh(params);
 427
 428                                 // render-to-target didn't work
 429                                 if(cc->inventory_texture == NULL)
 430                                 {
 431                                         cc->inventory_texture =
 432                                                 tsrc->getTexture(f.tiledef[0].name);
 433                                 }
 434                         }
 435
 436                         /*
 437                                 Use the node mesh as the wield mesh
 438                         */
 439
 440                         // Scale to proper wield mesh proportions
 441                         scaleMesh(node_mesh, v3f(30.0, 30.0, 30.0)
 442                                         * def->wield_scale);
 443
 444                         cc->wield_mesh = node_mesh;
 445                         cc->wield_mesh->grab();
 446
 447                         //no way reference count can be smaller than 2 in this place!
 448                         assert(cc->wield_mesh->getReferenceCount() >= 2);
 449                 }
 450
 451                 // Put in cache
 452                 m_clientcached.set(name, cc);
 453
 454                 return cc;
 455         }
 456         ClientCached* getClientCached(const std::string &name,
 457                         IGameDef *gamedef) const
 458         {
 459                 ClientCached *cc = NULL;
 460                 m_clientcached.get(name, &cc);
 461                 if(cc)
 462                         return cc;
 463
 464                 if(get_current_thread_id() == m_main_thread)
 465                 {
 466                         return createClientCachedDirect(name, gamedef);
 467                 }
 468                 else
 469                 {
 470                         // We're gonna ask the result to be put into here
 471                         ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
 472                         // Throw a request in
 473                         m_get_clientcached_queue.add(name, 0, 0, &result_queue);
 474                         try{
 475                                 // Wait result for a second
 476                                 GetResult<std::string, ClientCached*, u8, u8>
 477                                                 result = result_queue.pop_front(1000);
 478                                 // Check that at least something worked OK
 479                                 assert(result.key == name);
 480                                 // Return it
 481                                 return result.item;
 482                         }
 483                         catch(ItemNotFoundException &e)
 484                         {
 485                                 errorstream<<"Waiting for clientcached timed out."<<std::endl;
 486                                 return &m_dummy_clientcached;
 487                         }
 488                 }
 489         }
 490         // Get item inventory texture
 491         virtual video::ITexture* getInventoryTexture(const std::string &name,
 492                         IGameDef *gamedef) const
 493         {
 494                 ClientCached *cc = getClientCached(name, gamedef);
 495                 if(!cc)
 496                         return NULL;
 497                 return cc->inventory_texture;
 498         }
 499         // Get item wield mesh
 500         virtual scene::IMesh* getWieldMesh(const std::string &name,
 501                         IGameDef *gamedef) const
 502         {
 503                 ClientCached *cc = getClientCached(name, gamedef);
 504                 if(!cc)
 505                         return NULL;
 506                 return cc->wield_mesh;
 507         }
 508 #endif
 509         void clear()
 510         {
 511                 for(std::map<std::string, ItemDefinition*>::const_iterator
 512                                 i = m_item_definitions.begin();
 513                                 i != m_item_definitions.end(); i++)
 514                 {
 515                         delete i->second;
 516                 }
 517                 m_item_definitions.clear();
 518                 m_aliases.clear();
 519
 520                 // Add the four builtin items:
 521                 //   "" is the hand
 522                 //   "unknown" is returned whenever an undefined item is accessed
 523                 //   "air" is the air node
 524                 //   "ignore" is the ignore node
 525
 526                 ItemDefinition* hand_def = new ItemDefinition;
 527                 hand_def->name = "";
 528                 hand_def->wield_image = "wieldhand.png";
 529                 hand_def->tool_capabilities = new ToolCapabilities;
 530                 m_item_definitions.insert(std::make_pair("", hand_def));
 531
 532                 ItemDefinition* unknown_def = new ItemDefinition;
 533                 unknown_def->name = "unknown";
 534                 m_item_definitions.insert(std::make_pair("unknown", unknown_def));
 535
 536                 ItemDefinition* air_def = new ItemDefinition;
 537                 air_def->type = ITEM_NODE;
 538                 air_def->name = "air";
 539                 m_item_definitions.insert(std::make_pair("air", air_def));
 540
 541                 ItemDefinition* ignore_def = new ItemDefinition;
 542                 ignore_def->type = ITEM_NODE;
 543                 ignore_def->name = "ignore";
 544                 m_item_definitions.insert(std::make_pair("ignore", ignore_def));
 545         }
 546         virtual void registerItem(const ItemDefinition &def)
 547         {
 548                 verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
 549                 // Ensure that the "" item (the hand) always has ToolCapabilities
 550                 if(def.name == "")
 551                         assert(def.tool_capabilities != NULL);
 552
 553                 if(m_item_definitions.count(def.name) == 0)
 554                         m_item_definitions[def.name] = new ItemDefinition(def);
 555                 else
 556                         *(m_item_definitions[def.name]) = def;
 557
 558                 // Remove conflicting alias if it exists
 559                 bool alias_removed = (m_aliases.erase(def.name) != 0);
 560                 if(alias_removed)
 561                         infostream<<"ItemDefManager: erased alias "<<def.name
 562                                         <<" because item was defined"<<std::endl;
 563         }
 564         virtual void registerAlias(const std::string &name,
 565                         const std::string &convert_to)
 566         {
 567                 if(m_item_definitions.find(name) == m_item_definitions.end())
 568                 {
 569                         verbosestream<<"ItemDefManager: setting alias "<<name
 570                                 <<" -> "<<convert_to<<std::endl;
 571                         m_aliases[name] = convert_to;
 572                 }
 573         }
 574         void serialize(std::ostream &os, u16 protocol_version)
 575         {
 576                 writeU8(os, 0); // version
 577                 u16 count = m_item_definitions.size();
 578                 writeU16(os, count);
 579                 for(std::map<std::string, ItemDefinition*>::const_iterator
 580                                 i = m_item_definitions.begin();
 581                                 i != m_item_definitions.end(); i++)
 582                 {
 583                         ItemDefinition *def = i->second;
 584                         // Serialize ItemDefinition and write wrapped in a string
 585                         std::ostringstream tmp_os(std::ios::binary);
 586                         def->serialize(tmp_os, protocol_version);
 587                         os<<serializeString(tmp_os.str());
 588                 }
 589                 writeU16(os, m_aliases.size());
 590                 for(std::map<std::string, std::string>::const_iterator
 591                         i = m_aliases.begin(); i != m_aliases.end(); i++)
 592                 {
 593                         os<<serializeString(i->first);
 594                         os<<serializeString(i->second);
 595                 }
 596         }
 597         void deSerialize(std::istream &is)
 598         {
 599                 // Clear everything
 600                 clear();
 601                 // Deserialize
 602                 int version = readU8(is);
 603                 if(version != 0)
 604                         throw SerializationError("unsupported ItemDefManager version");
 605                 u16 count = readU16(is);
 606                 for(u16 i=0; i<count; i++)
 607                 {
 608                         // Deserialize a string and grab an ItemDefinition from it
 609                         std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
 610                         ItemDefinition def;
 611                         def.deSerialize(tmp_is);
 612                         // Register
 613                         registerItem(def);
 614                 }
 615                 u16 num_aliases = readU16(is);
 616                 for(u16 i=0; i<num_aliases; i++)
 617                 {
 618                         std::string name = deSerializeString(is);
 619                         std::string convert_to = deSerializeString(is);
 620                         registerAlias(name, convert_to);
 621                 }
 622         }
 623         void processQueue(IGameDef *gamedef)
 624         {
 625 #ifndef SERVER
 626                 while(!m_get_clientcached_queue.empty())
 627                 {
 628                         GetRequest<std::string, ClientCached*, u8, u8>
 629                                         request = m_get_clientcached_queue.pop();
 630                         GetResult<std::string, ClientCached*, u8, u8>
 631                                         result;
 632                         result.key = request.key;
 633                         result.callers = request.callers;
 634                         result.item = createClientCachedDirect(request.key, gamedef);
 635                         request.dest->push_back(result);
 636                 }
 637 #endif
 638         }
 639 private:
 640         // Key is name
 641         std::map<std::string, ItemDefinition*> m_item_definitions;
 642         // Aliases
 643         std::map<std::string, std::string> m_aliases;
 644 #ifndef SERVER
 645         // The id of the thread that is allowed to use irrlicht directly
 646         threadid_t m_main_thread;
 647         // A reference to this can be returned when nothing is found, to avoid NULLs
 648         mutable ClientCached m_dummy_clientcached;
 649         // Cached textures and meshes
 650         mutable MutexedMap<std::string, ClientCached*> m_clientcached;
 651         // Queued clientcached fetches (to be processed by the main thread)
 652         mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
 653 #endif
 654 };
 655
 656 IWritableItemDefManager* createItemDefManager()
 657 {
 658         return new CItemDefManager();
 659 }