]> git.lizzy.rs Git - minetest.git/blobdiff - src/itemdef.cpp
Dual wielding
[minetest.git] / src / itemdef.cpp
index 8eca8cafb5e51af608ad9480a5ef49cfcee115bf..e7e4948a3eaea64c24e89643eac57b6f42e870bb 100644 (file)
@@ -24,11 +24,11 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "tool.h"
 #include "inventory.h"
 #ifndef SERVER
-#include "mapblock_mesh.h"
-#include "mesh.h"
-#include "wieldmesh.h"
+#include "client/mapblock_mesh.h"
+#include "client/mesh.h"
+#include "client/wieldmesh.h"
 #include "client/tile.h"
-#include "client.h"
+#include "client/client.h"
 #endif
 #include "log.h"
 #include "settings.h"
@@ -38,10 +38,6 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include <map>
 #include <set>
 
-#ifdef __ANDROID__
-#include <GLES/gl.h>
-#endif
-
 /*
        ItemDefinition
 */
@@ -66,21 +62,26 @@ ItemDefinition& ItemDefinition::operator=(const ItemDefinition &def)
        type = def.type;
        name = def.name;
        description = def.description;
+       short_description = def.short_description;
        inventory_image = def.inventory_image;
+       inventory_overlay = def.inventory_overlay;
        wield_image = def.wield_image;
+       wield_overlay = def.wield_overlay;
        wield_scale = def.wield_scale;
        stack_max = def.stack_max;
        usable = def.usable;
        liquids_pointable = def.liquids_pointable;
-       if(def.tool_capabilities)
-       {
-               tool_capabilities = new ToolCapabilities(
-                               *def.tool_capabilities);
-       }
+       if (def.tool_capabilities)
+               tool_capabilities = new ToolCapabilities(*def.tool_capabilities);
        groups = def.groups;
        node_placement_prediction = def.node_placement_prediction;
+       place_param2 = def.place_param2;
+       has_on_place = def.has_on_place;
+       has_on_secondary_use = def.has_on_secondary_use;
        sound_place = def.sound_place;
        sound_place_failed = def.sound_place_failed;
+       sound_use = def.sound_use;
+       sound_use_air = def.sound_use_air;
        range = def.range;
        palette_image = def.palette_image;
        color = def.color;
@@ -102,11 +103,14 @@ void ItemDefinition::resetInitial()
 void ItemDefinition::reset()
 {
        type = ITEM_NONE;
-       name = "";
-       description = "";
-       inventory_image = "";
-       wield_image = "";
-       palette_image = "";
+       name.clear();
+       description.clear();
+       short_description.clear();
+       inventory_image.clear();
+       inventory_overlay.clear();
+       wield_image.clear();
+       wield_overlay.clear();
+       palette_image.clear();
        color = video::SColor(0xFFFFFFFF);
        wield_scale = v3f(1.0, 1.0, 1.0);
        stack_max = 99;
@@ -117,116 +121,129 @@ void ItemDefinition::reset()
        groups.clear();
        sound_place = SimpleSoundSpec();
        sound_place_failed = SimpleSoundSpec();
+       sound_use = SimpleSoundSpec();
+       sound_use_air = SimpleSoundSpec();
        range = -1;
-
-       node_placement_prediction = "";
+       node_placement_prediction.clear();
+       place_param2 = 0;
+       has_on_place = false;
+       has_on_secondary_use = false;
 }
 
 void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
 {
-       u8 version = (protocol_version >= 34) ? 4 : 3;
+       // protocol_version >= 37
+       u8 version = 6;
        writeU8(os, version);
        writeU8(os, type);
-       os << serializeString(name);
-       os << serializeString(description);
-       os << serializeString(inventory_image);
-       os << serializeString(wield_image);
-       writeV3F1000(os, wield_scale);
+       os << serializeString16(name);
+       os << serializeString16(description);
+       os << serializeString16(inventory_image);
+       os << serializeString16(wield_image);
+       writeV3F32(os, wield_scale);
        writeS16(os, stack_max);
        writeU8(os, usable);
        writeU8(os, liquids_pointable);
-       std::string tool_capabilities_s = "";
-       if(tool_capabilities){
+
+       std::string tool_capabilities_s;
+       if (tool_capabilities) {
                std::ostringstream tmp_os(std::ios::binary);
                tool_capabilities->serialize(tmp_os, protocol_version);
                tool_capabilities_s = tmp_os.str();
        }
-       os << serializeString(tool_capabilities_s);
+       os << serializeString16(tool_capabilities_s);
+
        writeU16(os, groups.size());
-       for (ItemGroupList::const_iterator
-                       i = groups.begin(); i != groups.end(); ++i){
-               os << serializeString(i->first);
-               writeS16(os, i->second);
-       }
-       os << serializeString(node_placement_prediction);
-       os << serializeString(sound_place.name);
-       writeF1000(os, sound_place.gain);
-       writeF1000(os, range);
-       os << serializeString(sound_place_failed.name);
-       writeF1000(os, sound_place_failed.gain);
-       os << serializeString(palette_image);
-       writeU32(os, color.color);
-
-       if (version >= 4) {
-               writeF1000(os, sound_place.pitch);
-               writeF1000(os, sound_place_failed.pitch);
+       for (const auto &group : groups) {
+               os << serializeString16(group.first);
+               writeS16(os, group.second);
        }
+
+       os << serializeString16(node_placement_prediction);
+
+       // Version from ContentFeatures::serialize to keep in sync
+       sound_place.serialize(os, protocol_version);
+       sound_place_failed.serialize(os, protocol_version);
+
+       writeF32(os, range);
+       os << serializeString16(palette_image);
+       writeARGB8(os, color);
+       os << serializeString16(inventory_overlay);
+       os << serializeString16(wield_overlay);
+
+       os << serializeString16(short_description);
+
+       os << place_param2;
+
+       sound_use.serialize(os, protocol_version);
+       sound_use_air.serialize(os, protocol_version);
+
+       writeU8(os, has_on_place);
+       writeU8(os, has_on_secondary_use);
 }
 
-void ItemDefinition::deSerialize(std::istream &is)
+void ItemDefinition::deSerialize(std::istream &is, u16 protocol_version)
 {
        // Reset everything
        reset();
 
        // Deserialize
        int version = readU8(is);
-       if (version < 1 || version > 4)
+       if (version < 6)
                throw SerializationError("unsupported ItemDefinition version");
+
        type = (enum ItemType)readU8(is);
-       name = deSerializeString(is);
-       description = deSerializeString(is);
-       inventory_image = deSerializeString(is);
-       wield_image = deSerializeString(is);
-       wield_scale = readV3F1000(is);
+       name = deSerializeString16(is);
+       description = deSerializeString16(is);
+       inventory_image = deSerializeString16(is);
+       wield_image = deSerializeString16(is);
+       wield_scale = readV3F32(is);
        stack_max = readS16(is);
        usable = readU8(is);
        liquids_pointable = readU8(is);
-       std::string tool_capabilities_s = deSerializeString(is);
-       if(!tool_capabilities_s.empty())
-       {
+
+       std::string tool_capabilities_s = deSerializeString16(is);
+       if (!tool_capabilities_s.empty()) {
                std::istringstream tmp_is(tool_capabilities_s, std::ios::binary);
                tool_capabilities = new ToolCapabilities;
                tool_capabilities->deSerialize(tmp_is);
        }
+
        groups.clear();
        u32 groups_size = readU16(is);
        for(u32 i=0; i<groups_size; i++){
-               std::string name = deSerializeString(is);
+               std::string name = deSerializeString16(is);
                int value = readS16(is);
                groups[name] = value;
        }
-       if(version == 1){
-               // We cant be sure that node_placement_prediction is send in version 1
-               try{
-                       node_placement_prediction = deSerializeString(is);
-               }catch(SerializationError &e) {};
-               // Set the old default sound
-               sound_place.name = "default_place_node";
-               sound_place.gain = 0.5;
-       } else if(version >= 2) {
-               node_placement_prediction = deSerializeString(is);
-               //deserializeSimpleSoundSpec(sound_place, is);
-               sound_place.name = deSerializeString(is);
-               sound_place.gain = readF1000(is);
-       }
-       if(version == 3) {
-               range = readF1000(is);
-       }
-       // If you add anything here, insert it primarily inside the try-catch
+
+       node_placement_prediction = deSerializeString16(is);
+
+       sound_place.deSerialize(is, protocol_version);
+       sound_place_failed.deSerialize(is, protocol_version);
+
+       range = readF32(is);
+       palette_image = deSerializeString16(is);
+       color = readARGB8(is);
+       inventory_overlay = deSerializeString16(is);
+       wield_overlay = deSerializeString16(is);
+
+       // If you add anything here, insert it inside the try-catch
        // block to not need to increase the version.
        try {
-               sound_place_failed.name = deSerializeString(is);
-               sound_place_failed.gain = readF1000(is);
-               palette_image = deSerializeString(is);
-               color.set(readU32(is));
-
-               if (version >= 4) {
-                       sound_place.pitch = readF1000(is);
-                       sound_place_failed.pitch = readF1000(is);
-               }
+               short_description = deSerializeString16(is);
+
+               place_param2 = readU8(is); // 0 if missing
+
+               sound_use.deSerialize(is, protocol_version);
+               sound_use_air.deSerialize(is, protocol_version);
+
+               has_on_place = readU8(is);
+               has_on_secondary_use = readU8(is);
        } catch(SerializationError &e) {};
 }
 
+
 /*
        CItemDefManager
 */
@@ -244,7 +261,6 @@ class CItemDefManager: public IWritableItemDefManager
 
                ClientCached():
                        inventory_texture(NULL),
-                       wield_mesh(),
                        palette(NULL)
                {}
        };
@@ -263,20 +279,15 @@ class CItemDefManager: public IWritableItemDefManager
        {
 #ifndef SERVER
                const std::vector<ClientCached*> &values = m_clientcached.getValues();
-               for(std::vector<ClientCached*>::const_iterator
-                               i = values.begin(); i != values.end(); ++i)
-               {
-                       ClientCached *cc = *i;
+               for (ClientCached *cc : values) {
                        if (cc->wield_mesh.mesh)
                                cc->wield_mesh.mesh->drop();
                        delete cc;
                }
 
 #endif
-               for (std::map<std::string, ItemDefinition*>::iterator iter =
-                               m_item_definitions.begin(); iter != m_item_definitions.end();
-                               ++iter) {
-                       delete iter->second;
+               for (auto &item_definition : m_item_definitions) {
+                       delete item_definition.second;
                }
                m_item_definitions.clear();
        }
@@ -285,32 +296,28 @@ class CItemDefManager: public IWritableItemDefManager
                // Convert name according to possible alias
                std::string name = getAlias(name_);
                // Get the definition
-               std::map<std::string, ItemDefinition*>::const_iterator i;
-               i = m_item_definitions.find(name);
-               if(i == m_item_definitions.end())
+               auto i = m_item_definitions.find(name);
+               if (i == m_item_definitions.cend())
                        i = m_item_definitions.find("unknown");
-               assert(i != m_item_definitions.end());
+               assert(i != m_item_definitions.cend());
                return *(i->second);
        }
        virtual const std::string &getAlias(const std::string &name) const
        {
-               StringMap::const_iterator it = m_aliases.find(name);
-               if (it != m_aliases.end())
+               auto it = m_aliases.find(name);
+               if (it != m_aliases.cend())
                        return it->second;
                return name;
        }
        virtual void getAll(std::set<std::string> &result) const
        {
                result.clear();
-               for(std::map<std::string, ItemDefinition *>::const_iterator
-                               it = m_item_definitions.begin();
-                               it != m_item_definitions.end(); ++it) {
-                       result.insert(it->first);
+               for (const auto &item_definition : m_item_definitions) {
+                       result.insert(item_definition.first);
                }
-               for (StringMap::const_iterator
-                               it = m_aliases.begin();
-                               it != m_aliases.end(); ++it) {
-                       result.insert(it->first);
+
+               for (const auto &alias : m_aliases) {
+                       result.insert(alias.first);
                }
        }
        virtual bool isKnown(const std::string &name_) const
@@ -318,8 +325,7 @@ class CItemDefManager: public IWritableItemDefManager
                // Convert name according to possible alias
                std::string name = getAlias(name_);
                // Get the definition
-               std::map<std::string, ItemDefinition*>::const_iterator i;
-               return m_item_definitions.find(name) != m_item_definitions.end();
+               return m_item_definitions.find(name) != m_item_definitions.cend();
        }
 #ifndef SERVER
 public:
@@ -346,7 +352,7 @@ class CItemDefManager: public IWritableItemDefManager
 
                // Create an inventory texture
                cc->inventory_texture = NULL;
-               if(def.inventory_image != "")
+               if (!def.inventory_image.empty())
                        cc->inventory_texture = tsrc->getTexture(def.inventory_image);
 
                ItemStack item = ItemStack();
@@ -371,28 +377,27 @@ class CItemDefManager: public IWritableItemDefManager
 
                if (std::this_thread::get_id() == m_main_thread) {
                        return createClientCachedDirect(name, client);
-               } else {
-                       // We're gonna ask the result to be put into here
-                       static ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
-
-                       // Throw a request in
-                       m_get_clientcached_queue.add(name, 0, 0, &result_queue);
-                       try{
-                               while(true) {
-                                       // Wait result for a second
-                                       GetResult<std::string, ClientCached*, u8, u8>
-                                               result = result_queue.pop_front(1000);
-
-                                       if (result.key == name) {
-                                               return result.item;
-                                       }
+               }
+
+               // We're gonna ask the result to be put into here
+               static ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
+
+               // Throw a request in
+               m_get_clientcached_queue.add(name, 0, 0, &result_queue);
+               try {
+                       while(true) {
+                               // Wait result for a second
+                               GetResult<std::string, ClientCached*, u8, u8>
+                                       result = result_queue.pop_front(1000);
+
+                               if (result.key == name) {
+                                       return result.item;
                                }
                        }
-                       catch(ItemNotFoundException &e)
-                       {
-                               errorstream<<"Waiting for clientcached " << name << " timed out."<<std::endl;
-                               return &m_dummy_clientcached;
-                       }
+               } catch(ItemNotFoundException &e) {
+                       errorstream << "Waiting for clientcached " << name
+                               << " timed out." << std::endl;
+                       return &m_dummy_clientcached;
                }
        }
        // Get item inventory texture
@@ -430,25 +435,41 @@ class CItemDefManager: public IWritableItemDefManager
                // Look for direct color definition
                const std::string &colorstring = stack.metadata.getString("color", 0);
                video::SColor directcolor;
-               if ((colorstring != "")
-                               && parseColorString(colorstring, directcolor, true))
+               if (!colorstring.empty() && parseColorString(colorstring, directcolor, true))
                        return directcolor;
                // See if there is a palette
                Palette *palette = getPalette(stack.name, client);
                const std::string &index = stack.metadata.getString("palette_index", 0);
-               if ((palette != NULL) && (index != ""))
+               if (palette && !index.empty())
                        return (*palette)[mystoi(index, 0, 255)];
                // Fallback color
                return get(stack.name).color;
        }
 #endif
+       void applyTextureOverrides(const std::vector<TextureOverride> &overrides)
+       {
+               infostream << "ItemDefManager::applyTextureOverrides(): Applying "
+                       "overrides to textures" << std::endl;
+
+               for (const TextureOverride& texture_override : overrides) {
+                       if (m_item_definitions.find(texture_override.id) == m_item_definitions.end()) {
+                               continue; // Ignore unknown item
+                       }
+
+                       ItemDefinition* itemdef = m_item_definitions[texture_override.id];
+
+                       if (texture_override.hasTarget(OverrideTarget::INVENTORY))
+                               itemdef->inventory_image = texture_override.texture;
+
+                       if (texture_override.hasTarget(OverrideTarget::WIELD))
+                               itemdef->wield_image = texture_override.texture;
+               }
+       }
        void clear()
        {
-               for(std::map<std::string, ItemDefinition*>::const_iterator
-                               i = m_item_definitions.begin();
-                               i != m_item_definitions.end(); ++i)
+               for (auto &i : m_item_definitions)
                {
-                       delete i->second;
+                       delete i.second;
                }
                m_item_definitions.clear();
                m_aliases.clear();
@@ -461,7 +482,7 @@ class CItemDefManager: public IWritableItemDefManager
                //   "ignore" is the ignore node
 
                ItemDefinition* hand_def = new ItemDefinition;
-               hand_def->name = "";
+               hand_def->name.clear();
                hand_def->wield_image = "wieldhand.png";
                hand_def->tool_capabilities = new ToolCapabilities;
                m_item_definitions.insert(std::make_pair("", hand_def));
@@ -483,9 +504,9 @@ class CItemDefManager: public IWritableItemDefManager
        }
        virtual void registerItem(const ItemDefinition &def)
        {
-               verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
+               TRACESTREAM(<< "ItemDefManager: registering " << def.name << std::endl);
                // Ensure that the "" item (the hand) always has ToolCapabilities
-               if(def.name == "")
+               if (def.name.empty())
                        FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
 
                if(m_item_definitions.count(def.name) == 0)
@@ -510,8 +531,8 @@ class CItemDefManager: public IWritableItemDefManager
                        const std::string &convert_to)
        {
                if (m_item_definitions.find(name) == m_item_definitions.end()) {
-                       verbosestream<<"ItemDefManager: setting alias "<<name
-                               <<" -> "<<convert_to<<std::endl;
+                       TRACESTREAM(<< "ItemDefManager: setting alias " << name
+                               << " -> " << convert_to << std::endl);
                        m_aliases[name] = convert_to;
                }
        }
@@ -521,48 +542,44 @@ class CItemDefManager: public IWritableItemDefManager
                u16 count = m_item_definitions.size();
                writeU16(os, count);
 
-               for (std::map<std::string, ItemDefinition *>::const_iterator
-                               it = m_item_definitions.begin();
-                               it != m_item_definitions.end(); ++it) {
-                       ItemDefinition *def = it->second;
+               for (const auto &it : m_item_definitions) {
+                       ItemDefinition *def = it.second;
                        // Serialize ItemDefinition and write wrapped in a string
                        std::ostringstream tmp_os(std::ios::binary);
                        def->serialize(tmp_os, protocol_version);
-                       os << serializeString(tmp_os.str());
+                       os << serializeString16(tmp_os.str());
                }
 
                writeU16(os, m_aliases.size());
 
-               for (StringMap::const_iterator
-                               it = m_aliases.begin();
-                               it != m_aliases.end(); ++it) {
-                       os << serializeString(it->first);
-                       os << serializeString(it->second);
+               for (const auto &it : m_aliases) {
+                       os << serializeString16(it.first);
+                       os << serializeString16(it.second);
                }
        }
-       void deSerialize(std::istream &is)
+       void deSerialize(std::istream &is, u16 protocol_version)
        {
                // Clear everything
                clear();
-               // Deserialize
-               int version = readU8(is);
-               if(version != 0)
+
+               if(readU8(is) != 0)
                        throw SerializationError("unsupported ItemDefManager version");
+
                u16 count = readU16(is);
                for(u16 i=0; i<count; i++)
                {
                        // Deserialize a string and grab an ItemDefinition from it
-                       std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
+                       std::istringstream tmp_is(deSerializeString16(is), std::ios::binary);
                        ItemDefinition def;
-                       def.deSerialize(tmp_is);
+                       def.deSerialize(tmp_is, protocol_version);
                        // Register
                        registerItem(def);
                }
                u16 num_aliases = readU16(is);
                for(u16 i=0; i<num_aliases; i++)
                {
-                       std::string name = deSerializeString(is);
-                       std::string convert_to = deSerializeString(is);
+                       std::string name = deSerializeString16(is);
+                       std::string convert_to = deSerializeString16(is);
                        registerAlias(name, convert_to);
                }
        }