]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/itemdef.cpp
Don't include client/game.h on server build
[dragonfireclient.git] / src / itemdef.cpp
index ad4eafe811a1f578b2255f43c7962e70790d0b5d..d79d6b263f9860f25a1ee06bac12fba07846889f 100644 (file)
@@ -52,9 +52,9 @@ ItemDefinition::ItemDefinition(const ItemDefinition &def)
        *this = def;
 }
 
-ItemDefinition &ItemDefinition::operator=(const ItemDefinition &def)
+ItemDefinitionItemDefinition::operator=(const ItemDefinition &def)
 {
-       if (this == &def)
+       if(this == &def)
                return *this;
 
        reset();
@@ -62,6 +62,7 @@ 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;
@@ -70,11 +71,11 @@ ItemDefinition &ItemDefinition::operator=(const ItemDefinition &def)
        stack_max = def.stack_max;
        usable = def.usable;
        liquids_pointable = def.liquids_pointable;
-       if (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;
        sound_place = def.sound_place;
        sound_place_failed = def.sound_place_failed;
        range = def.range;
@@ -100,6 +101,7 @@ void ItemDefinition::reset()
        type = ITEM_NONE;
        name = "";
        description = "";
+       short_description = "";
        inventory_image = "";
        inventory_overlay = "";
        wield_image = "";
@@ -116,8 +118,8 @@ void ItemDefinition::reset()
        sound_place = SimpleSoundSpec();
        sound_place_failed = SimpleSoundSpec();
        range = -1;
-
        node_placement_prediction = "";
+       place_param2 = 0;
 }
 
 void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
@@ -126,10 +128,10 @@ void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
        u8 version = 6;
        writeU8(os, version);
        writeU8(os, type);
-       os << serializeString(name);
-       os << serializeString(description);
-       os << serializeString(inventory_image);
-       os << serializeString(wield_image);
+       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);
@@ -141,25 +143,29 @@ void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
                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 (const auto &group : groups) {
-               os << serializeString(group.first);
+               os << serializeString16(group.first);
                writeS16(os, group.second);
        }
 
-       os << serializeString(node_placement_prediction);
+       os << serializeString16(node_placement_prediction);
 
        // Version from ContentFeatures::serialize to keep in sync
        sound_place.serialize(os, CONTENTFEATURES_VERSION);
        sound_place_failed.serialize(os, CONTENTFEATURES_VERSION);
 
        writeF32(os, range);
-       os << serializeString(palette_image);
+       os << serializeString16(palette_image);
        writeARGB8(os, color);
-       os << serializeString(inventory_overlay);
-       os << serializeString(wield_overlay);
+       os << serializeString16(inventory_overlay);
+       os << serializeString16(wield_overlay);
+
+       os << serializeString16(short_description);
+
+       os << place_param2;
 }
 
 void ItemDefinition::deSerialize(std::istream &is)
@@ -173,16 +179,16 @@ void ItemDefinition::deSerialize(std::istream &is)
                throw SerializationError("unsupported ItemDefinition version");
 
        type = (enum ItemType)readU8(is);
-       name = deSerializeString(is);
-       description = deSerializeString(is);
-       inventory_image = deSerializeString(is);
-       wield_image = deSerializeString(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);
+       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;
@@ -191,37 +197,41 @@ void ItemDefinition::deSerialize(std::istream &is)
 
        groups.clear();
        u32 groups_size = readU16(is);
-       for (u32 i = 0; i < groups_size; i++) {
-               std::string name = deSerializeString(is);
+       for(u32 i=0; i<groups_size; i++){
+               std::string name = deSerializeString16(is);
                int value = readS16(is);
                groups[name] = value;
        }
 
-       node_placement_prediction = deSerializeString(is);
+       node_placement_prediction = deSerializeString16(is);
 
        // Version from ContentFeatures::serialize to keep in sync
        sound_place.deSerialize(is, CONTENTFEATURES_VERSION);
        sound_place_failed.deSerialize(is, CONTENTFEATURES_VERSION);
 
        range = readF32(is);
-       palette_image = deSerializeString(is);
+       palette_image = deSerializeString16(is);
        color = readARGB8(is);
-       inventory_overlay = deSerializeString(is);
-       wield_overlay = deSerializeString(is);
+       inventory_overlay = deSerializeString16(is);
+       wield_overlay = deSerializeString16(is);
 
        // If you add anything here, insert it primarily inside the try-catch
        // block to not need to increase the version.
-       // try {
-       //} catch(SerializationError &e) {};
+       try {
+               short_description = deSerializeString16(is);
+
+               place_param2 = readU8(is); // 0 if missing
+       } catch(SerializationError &e) {};
 }
 
+
 /*
        CItemDefManager
 */
 
 // SUGG: Support chains of aliases?
 
-class CItemDefManager : public IWritableItemDefManager
+class CItemDefManager: public IWritableItemDefManager
 {
 #ifndef SERVER
        struct ClientCached
@@ -230,7 +240,10 @@ class CItemDefManager : public IWritableItemDefManager
                ItemMesh wield_mesh;
                Palette *palette;
 
-               ClientCached() : inventory_texture(NULL), palette(NULL) {}
+               ClientCached():
+                       inventory_texture(NULL),
+                       palette(NULL)
+               {}
        };
 #endif
 
@@ -246,7 +259,7 @@ class CItemDefManager : public IWritableItemDefManager
        virtual ~CItemDefManager()
        {
 #ifndef SERVER
-               const std::vector<ClientCached *> &values = m_clientcached.getValues();
+               const std::vector<ClientCached*> &values = m_clientcached.getValues();
                for (ClientCached *cc : values) {
                        if (cc->wield_mesh.mesh)
                                cc->wield_mesh.mesh->drop();
@@ -259,7 +272,7 @@ class CItemDefManager : public IWritableItemDefManager
                }
                m_item_definitions.clear();
        }
-       virtual const ItemDefinition &get(const std::string &name_) const
+       virtual const ItemDefinitionget(const std::string &name_) const
        {
                // Convert name according to possible alias
                std::string name = getAlias(name_);
@@ -297,11 +310,11 @@ class CItemDefManager : public IWritableItemDefManager
        }
 #ifndef SERVER
 public:
-       ClientCached *createClientCachedDirect(
-                       const std::string &name, Client *client) const
+       ClientCached* createClientCachedDirect(const std::string &name,
+                       Client *client) const
        {
-               infostream << "Lazily creating item texture and mesh for \"" << name
-                          << "\"" << std::endl;
+               infostream<<"Lazily creating item texture and mesh for \""
+                               <<name<<"\""<<std::endl;
 
                // This is not thread-safe
                sanity_check(std::this_thread::get_id() == m_main_thread);
@@ -309,7 +322,7 @@ class CItemDefManager : public IWritableItemDefManager
                // Skip if already in cache
                ClientCached *cc = NULL;
                m_clientcached.get(name, &cc);
-               if (cc)
+               if(cc)
                        return cc;
 
                ITextureSource *tsrc = client->getTextureSource();
@@ -335,7 +348,8 @@ class CItemDefManager : public IWritableItemDefManager
 
                return cc;
        }
-       ClientCached *getClientCached(const std::string &name, Client *client) const
+       ClientCached* getClientCached(const std::string &name,
+                       Client *client) const
        {
                ClientCached *cc = NULL;
                m_clientcached.get(name, &cc);
@@ -347,61 +361,62 @@ class CItemDefManager : public IWritableItemDefManager
                }
 
                // We're gonna ask the result to be put into here
-               static ResultQueue<std::string, ClientCached *, u8, u8> result_queue;
+               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) {
+                       while(true) {
                                // Wait result for a second
-                               GetResult<std::string, ClientCached *, u8, u8> result =
-                                               result_queue.pop_front(1000);
+                               GetResult<std::string, ClientCached*, u8, u8>
+                                       result = result_queue.pop_front(1000);
 
                                if (result.key == name) {
                                        return result.item;
                                }
                        }
-               } catch (ItemNotFoundException &e) {
+               } catch(ItemNotFoundException &e) {
                        errorstream << "Waiting for clientcached " << name
-                                   << " timed out." << std::endl;
+                               << " timed out." << std::endl;
                        return &m_dummy_clientcached;
                }
        }
        // Get item inventory texture
-       virtual video::ITexture *getInventoryTexture(
-                       const std::string &name, Client *client) const
+       virtual video::ITexture* getInventoryTexture(const std::string &name,
+                       Client *client) const
        {
                ClientCached *cc = getClientCached(name, client);
-               if (!cc)
+               if(!cc)
                        return NULL;
                return cc->inventory_texture;
        }
        // Get item wield mesh
-       virtual ItemMesh *getWieldMesh(const std::string &name, Client *client) const
+       virtual ItemMesh* getWieldMesh(const std::string &name,
+                       Client *client) const
        {
                ClientCached *cc = getClientCached(name, client);
-               if (!cc)
+               if(!cc)
                        return NULL;
                return &(cc->wield_mesh);
        }
 
        // Get item palette
-       virtual Palette *getPalette(const std::string &name, Client *client) const
+       virtual Palette* getPalette(const std::string &name,
+                       Client *client) const
        {
                ClientCached *cc = getClientCached(name, client);
-               if (!cc)
+               if(!cc)
                        return NULL;
                return cc->palette;
        }
 
-       virtual video::SColor getItemstackColor(
-                       const ItemStack &stack, Client *client) const
+       virtual video::SColor getItemstackColor(const ItemStack &stack,
+               Client *client) const
        {
                // Look for direct color definition
                const std::string &colorstring = stack.metadata.getString("color", 0);
                video::SColor directcolor;
-               if (!colorstring.empty() &&
-                               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);
@@ -415,16 +430,14 @@ class CItemDefManager : public IWritableItemDefManager
        void applyTextureOverrides(const std::vector<TextureOverride> &overrides)
        {
                infostream << "ItemDefManager::applyTextureOverrides(): Applying "
-                             "overrides to textures"
-                          << std::endl;
+                       "overrides to textures" << std::endl;
 
-               for (const TextureOverride &texture_override : overrides) {
-                       if (m_item_definitions.find(texture_override.id) ==
-                                       m_item_definitions.end()) {
+               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];
+                       ItemDefinitionitemdef = m_item_definitions[texture_override.id];
 
                        if (texture_override.hasTarget(OverrideTarget::INVENTORY))
                                itemdef->inventory_image = texture_override.texture;
@@ -435,7 +448,8 @@ class CItemDefManager : public IWritableItemDefManager
        }
        void clear()
        {
-               for (auto &i : m_item_definitions) {
+               for (auto &i : m_item_definitions)
+               {
                        delete i.second;
                }
                m_item_definitions.clear();
@@ -448,23 +462,23 @@ class CItemDefManager : public IWritableItemDefManager
                //   "air" is the air node
                //   "ignore" is the ignore node
 
-               ItemDefinition *hand_def = new ItemDefinition;
+               ItemDefinitionhand_def = new ItemDefinition;
                hand_def->name = "";
                hand_def->wield_image = "wieldhand.png";
                hand_def->tool_capabilities = new ToolCapabilities;
                m_item_definitions.insert(std::make_pair("", hand_def));
 
-               ItemDefinition *unknown_def = new ItemDefinition;
+               ItemDefinitionunknown_def = new ItemDefinition;
                unknown_def->type = ITEM_NODE;
                unknown_def->name = "unknown";
                m_item_definitions.insert(std::make_pair("unknown", unknown_def));
 
-               ItemDefinition *air_def = new ItemDefinition;
+               ItemDefinitionair_def = new ItemDefinition;
                air_def->type = ITEM_NODE;
                air_def->name = "air";
                m_item_definitions.insert(std::make_pair("air", air_def));
 
-               ItemDefinition *ignore_def = new ItemDefinition;
+               ItemDefinitionignore_def = new ItemDefinition;
                ignore_def->type = ITEM_NODE;
                ignore_def->name = "ignore";
                m_item_definitions.insert(std::make_pair("ignore", ignore_def));
@@ -474,33 +488,32 @@ class CItemDefManager : public IWritableItemDefManager
                TRACESTREAM(<< "ItemDefManager: registering " << def.name << std::endl);
                // Ensure that the "" item (the hand) always has ToolCapabilities
                if (def.name.empty())
-                       FATAL_ERROR_IF(!def.tool_capabilities,
-                                       "Hand does not have ToolCapabilities");
+                       FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
 
-               if (m_item_definitions.count(def.name) == 0)
+               if(m_item_definitions.count(def.name) == 0)
                        m_item_definitions[def.name] = new ItemDefinition(def);
                else
                        *(m_item_definitions[def.name]) = def;
 
                // Remove conflicting alias if it exists
                bool alias_removed = (m_aliases.erase(def.name) != 0);
-               if (alias_removed)
-                       infostream << "ItemDefManager: erased alias " << def.name
-                                  << " because item was defined" << std::endl;
+               if(alias_removed)
+                       infostream<<"ItemDefManager: erased alias "<<def.name
+                                       <<" because item was defined"<<std::endl;
        }
        virtual void unregisterItem(const std::string &name)
        {
-               verbosestream << "ItemDefManager: unregistering \"" << name << "\""
-                             << std::endl;
+               verbosestream<<"ItemDefManager: unregistering \""<<name<<"\""<<std::endl;
 
                delete m_item_definitions[name];
                m_item_definitions.erase(name);
        }
-       virtual void registerAlias(const std::string &name, const std::string &convert_to)
+       virtual void registerAlias(const std::string &name,
+                       const std::string &convert_to)
        {
                if (m_item_definitions.find(name) == m_item_definitions.end()) {
-                       TRACESTREAM(<< "ItemDefManager: setting alias " << name << " -> "
-                                   << convert_to << std::endl);
+                       TRACESTREAM(<< "ItemDefManager: setting alias " << name
+                               << " -> " << convert_to << std::endl);
                        m_aliases[name] = convert_to;
                }
        }
@@ -515,14 +528,14 @@ class CItemDefManager : public IWritableItemDefManager
                        // 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 (const auto &it : m_aliases) {
-                       os << serializeString(it.first);
-                       os << serializeString(it.second);
+                       os << serializeString16(it.first);
+                       os << serializeString16(it.second);
                }
        }
        void deSerialize(std::istream &is)
@@ -531,43 +544,43 @@ class CItemDefManager : public IWritableItemDefManager
                clear();
                // Deserialize
                int version = readU8(is);
-               if (version != 0)
+               if(version != 0)
                        throw SerializationError("unsupported ItemDefManager version");
                u16 count = readU16(is);
-               for (u16 i = 0; i < count; i++) {
+               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);
                        // 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);
+               for(u16 i=0; i<num_aliases; i++)
+               {
+                       std::string name = deSerializeString16(is);
+                       std::string convert_to = deSerializeString16(is);
                        registerAlias(name, convert_to);
                }
        }
        void processQueue(IGameDef *gamedef)
        {
 #ifndef SERVER
-               // NOTE this is only thread safe for ONE consumer thread!
-               while (!m_get_clientcached_queue.empty()) {
-                       GetRequest<std::string, ClientCached *, u8, u8> request =
-                                       m_get_clientcached_queue.pop();
-
-                       m_get_clientcached_queue.pushResult(
-                                       request, createClientCachedDirect(request.key,
-                                                                (Client *)gamedef));
+               //NOTE this is only thread safe for ONE consumer thread!
+               while(!m_get_clientcached_queue.empty())
+               {
+                       GetRequest<std::string, ClientCached*, u8, u8>
+                                       request = m_get_clientcached_queue.pop();
+
+                       m_get_clientcached_queue.pushResult(request,
+                                       createClientCachedDirect(request.key, (Client *)gamedef));
                }
 #endif
        }
-
 private:
        // Key is name
-       std::map<std::string, ItemDefinition *> m_item_definitions;
+       std::map<std::string, ItemDefinition*> m_item_definitions;
        // Aliases
        StringMap m_aliases;
 #ifndef SERVER
@@ -576,14 +589,13 @@ class CItemDefManager : public IWritableItemDefManager
        // A reference to this can be returned when nothing is found, to avoid NULLs
        mutable ClientCached m_dummy_clientcached;
        // Cached textures and meshes
-       mutable MutexedMap<std::string, ClientCached *> m_clientcached;
+       mutable MutexedMap<std::string, ClientCached*> m_clientcached;
        // Queued clientcached fetches (to be processed by the main thread)
-       mutable RequestQueue<std::string, ClientCached *, u8, u8>
-                       m_get_clientcached_queue;
+       mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
 #endif
 };
 
-IWritableItemDefManager *createItemDefManager()
+IWritableItemDefManagercreateItemDefManager()
 {
        return new CItemDefManager();
 }