X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Fitemdef.cpp;h=d79d6b263f9860f25a1ee06bac12fba07846889f;hb=7f4fc6f8a77cd0e454ce98ff92da8c8d6592afba;hp=fa277f4ffe1ddb5310022b565a4165c607ae90b8;hpb=f14e7bac54af65e3d3d99f89f23f114b17058e49;p=dragonfireclient.git diff --git a/src/itemdef.cpp b/src/itemdef.cpp index fa277f4ff..d79d6b263 100644 --- a/src/itemdef.cpp +++ b/src/itemdef.cpp @@ -20,22 +20,23 @@ with this program; if not, write to the Free Software Foundation, Inc., #include "itemdef.h" -#include "gamedef.h" #include "nodedef.h" #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/client.h" #endif #include "log.h" #include "settings.h" #include "util/serialize.h" - -#ifdef __ANDROID__ -#include -#endif +#include "util/container.h" +#include "util/thread.h" +#include +#include /* ItemDefinition @@ -61,22 +62,25 @@ 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; sound_place = def.sound_place; sound_place_failed = def.sound_place_failed; range = def.range; + palette_image = def.palette_image; + color = def.color; return *this; } @@ -97,66 +101,71 @@ void ItemDefinition::reset() type = ITEM_NONE; name = ""; description = ""; + short_description = ""; inventory_image = ""; + inventory_overlay = ""; wield_image = ""; + wield_overlay = ""; + palette_image = ""; + color = video::SColor(0xFFFFFFFF); wield_scale = v3f(1.0, 1.0, 1.0); stack_max = 99; usable = false; liquids_pointable = false; - if(tool_capabilities) - { - delete tool_capabilities; - tool_capabilities = NULL; - } + delete tool_capabilities; + tool_capabilities = NULL; groups.clear(); 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 { - if(protocol_version <= 17) - writeU8(os, 1); // version - else if(protocol_version <= 20) - writeU8(os, 2); // version - else - writeU8(os, 3); // version + // protocol_version >= 37 + u8 version = 6; + writeU8(os, version); writeU8(os, type); - os<serialize(tmp_os, protocol_version); tool_capabilities_s = tmp_os.str(); } - os<::const_iterator - i = groups.begin(); i != groups.end(); ++i){ - os<first); - writeS16(os, i->second); - } - os< 17){ - //serializeSimpleSoundSpec(sound_place, os); - os< 20) { - writeF1000(os, range); - os << serializeString(sound_place_failed.name); - writeF1000(os, sound_place_failed.gain); + 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, CONTENTFEATURES_VERSION); + sound_place_failed.serialize(os, CONTENTFEATURES_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; } void ItemDefinition::deSerialize(std::istream &is) @@ -166,221 +175,198 @@ void ItemDefinition::deSerialize(std::istream &is) // Deserialize int version = readU8(is); - if(version < 1 || version > 3) + 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= 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); - } + + 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 = deSerializeString16(is); + color = readARGB8(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 { - sound_place_failed.name = deSerializeString(is); - sound_place_failed.gain = readF1000(is); + short_description = deSerializeString16(is); + + place_param2 = readU8(is); // 0 if missing } catch(SerializationError &e) {}; } + /* CItemDefManager */ // SUGG: Support chains of aliases? -#ifndef SERVER -CItemDefManager::ClientCached::ClientCached() : - inventory_texture(NULL), - wield_mesh(NULL) -{} -#endif - -CItemDefManager::CItemDefManager() +class CItemDefManager: public IWritableItemDefManager { #ifndef SERVER - m_main_thread = thr_get_current_thread_id(); + struct ClientCached + { + video::ITexture *inventory_texture; + ItemMesh wield_mesh; + Palette *palette; + + ClientCached(): + inventory_texture(NULL), + palette(NULL) + {} + }; #endif - clear(); -} -/******************************************************************************/ -CItemDefManager::~CItemDefManager() -{ +public: + CItemDefManager() + { + #ifndef SERVER - const std::vector &values = m_clientcached.getValues(); - for(std::vector::const_iterator - i = values.begin(); i != values.end(); ++i) { - - ClientCached *cc = *i; - if (cc->wield_mesh) - cc->wield_mesh->drop(); - delete cc; + m_main_thread = std::this_thread::get_id(); +#endif + clear(); } + virtual ~CItemDefManager() + { +#ifndef SERVER + const std::vector &values = m_clientcached.getValues(); + for (ClientCached *cc : values) { + if (cc->wield_mesh.mesh) + cc->wield_mesh.mesh->drop(); + delete cc; + } #endif - for (std::map::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(); } - m_item_definitions.clear(); -} - -/******************************************************************************/ -const ItemDefinition& CItemDefManager::get(const std::string &name_) const -{ - // Convert name according to possible alias - std::string name = getAlias(name_); - // Get the definition - std::map::const_iterator i; - i = m_item_definitions.find(name); - if(i == m_item_definitions.end()) - i = m_item_definitions.find("unknown"); - assert(i != m_item_definitions.end()); - return *(i->second); -} - -/******************************************************************************/ -std::string CItemDefManager::getAlias(const std::string &name) const -{ - StringMap::const_iterator it = m_aliases.find(name); - if (it != m_aliases.end()) - return it->second; - - return name; -} - -/******************************************************************************/ -std::set CItemDefManager::getAll() const -{ - std::set result; - for(std::map::const_iterator - it = m_item_definitions.begin(); - it != m_item_definitions.end(); ++it) { - - result.insert(it->first); + virtual const ItemDefinition& get(const std::string &name_) const + { + // Convert name according to possible alias + std::string name = getAlias(name_); + // Get the definition + auto i = m_item_definitions.find(name); + if (i == m_item_definitions.cend()) + i = m_item_definitions.find("unknown"); + assert(i != m_item_definitions.cend()); + return *(i->second); } - for (StringMap::const_iterator - it = m_aliases.begin(); - it != m_aliases.end(); ++it) { - - result.insert(it->first); + virtual const std::string &getAlias(const std::string &name) const + { + auto it = m_aliases.find(name); + if (it != m_aliases.cend()) + return it->second; + return name; } - return result; -} - -/******************************************************************************/ -bool CItemDefManager::isKnown(const std::string &name_) const -{ - // Convert name according to possible alias - std::string name = getAlias(name_); - // Get the definition - std::map::const_iterator i; + virtual void getAll(std::set &result) const + { + result.clear(); + for (const auto &item_definition : m_item_definitions) { + result.insert(item_definition.first); + } - return m_item_definitions.find(name) != m_item_definitions.end(); -} + for (const auto &alias : m_aliases) { + result.insert(alias.first); + } + } + virtual bool isKnown(const std::string &name_) const + { + // Convert name according to possible alias + std::string name = getAlias(name_); + // Get the definition + return m_item_definitions.find(name) != m_item_definitions.cend(); + } #ifndef SERVER +public: + ClientCached* createClientCachedDirect(const std::string &name, + Client *client) const + { + infostream<<"Lazily creating item texture and mesh for \"" + <getTextureSource(); + const ItemDefinition &def = get(name); - ITextureSource *tsrc = gamedef->getTextureSource(); - INodeDefManager *nodedef = gamedef->getNodeDefManager(); - const ItemDefinition &def = get(name); - - // Create new ClientCached - cc = new ClientCached(); - - // Create an inventory texture - cc->inventory_texture = NULL; - if (def.inventory_image != "") - cc->inventory_texture = tsrc->getTexture(def.inventory_image); - - // Additional processing for nodes: - // - Create a wield mesh if WieldMeshSceneNode can't render - // the node on its own. - // - If inventory_texture isn't set yet, create one using - // render-to-texture. - if (def.type == ITEM_NODE) { - createNodeItemTexture(name, def, nodedef, cc, gamedef, tsrc); - } + // Create new ClientCached + cc = new ClientCached(); - // Put in cache - m_clientcached.set(name, cc); + // Create an inventory texture + cc->inventory_texture = NULL; + if (!def.inventory_image.empty()) + cc->inventory_texture = tsrc->getTexture(def.inventory_image); - return cc; -} + ItemStack item = ItemStack(); + item.name = def.name; -/******************************************************************************/ -CItemDefManager::ClientCached* CItemDefManager::getClientCached(const std::string &name, - IGameDef *gamedef) const -{ - ClientCached *cc = NULL; - m_clientcached.get(name, &cc); - if (cc) - return cc; + getItemMesh(client, item, &(cc->wield_mesh)); - if (thr_is_current_thread(m_main_thread)) { + cc->palette = tsrc->getPalette(def.palette_image); - return createClientCachedDirect(name, gamedef); + // Put in cache + m_clientcached.set(name, cc); + + return cc; } - else + ClientCached* getClientCached(const std::string &name, + Client *client) const { + ClientCached *cc = NULL; + m_clientcached.get(name, &cc); + if (cc) + return cc; + + if (std::this_thread::get_id() == m_main_thread) { + return createClientCachedDirect(name, client); + } + // We're gonna ask the result to be put into here static ResultQueue result_queue; // Throw a request in m_get_clientcached_queue.add(name, 0, 0, &result_queue); - try{ - while (true) { + try { + while(true) { // Wait result for a second GetResult result = result_queue.pop_front(1000); @@ -389,270 +375,225 @@ CItemDefManager::ClientCached* CItemDefManager::getClientCached(const std::strin return result.item; } } - } - catch(ItemNotFoundException &e) - { - errorstream<<"Waiting for clientcached " << name << " timed out."<inventory_texture; -} + // Get item inventory texture + virtual video::ITexture* getInventoryTexture(const std::string &name, + Client *client) const + { + ClientCached *cc = getClientCached(name, client); + if(!cc) + return NULL; + return cc->inventory_texture; + } + // Get item wield mesh + virtual ItemMesh* getWieldMesh(const std::string &name, + Client *client) const + { + ClientCached *cc = getClientCached(name, client); + if(!cc) + return NULL; + return &(cc->wield_mesh); + } -/******************************************************************************/ -// Get item wield mesh -scene::IMesh* CItemDefManager::getWieldMesh(const std::string &name, - IGameDef *gamedef) const -{ - ClientCached *cc = getClientCached(name, gamedef); - if (!cc) - return NULL; + // Get item palette + virtual Palette* getPalette(const std::string &name, + Client *client) const + { + ClientCached *cc = getClientCached(name, client); + if(!cc) + return NULL; + return cc->palette; + } - return cc->wield_mesh; -} + 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)) + 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 && !index.empty()) + return (*palette)[mystoi(index, 0, 255)]; + // Fallback color + return get(stack.name).color; + } #endif + void applyTextureOverrides(const std::vector &overrides) + { + infostream << "ItemDefManager::applyTextureOverrides(): Applying " + "overrides to textures" << std::endl; -/******************************************************************************/ -void CItemDefManager::clear() -{ - for (std::map::const_iterator - i = m_item_definitions.begin(); - i != m_item_definitions.end(); ++i) { - - delete i->second; - } - m_item_definitions.clear(); - m_aliases.clear(); - - // Add the four builtin items: - // "" is the hand - // "unknown" is returned whenever an undefined item - // is accessed (is also the unknown node) - // "air" is the air node - // "ignore" is the ignore node - - ItemDefinition* hand_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; - unknown_def->type = ITEM_NODE; - unknown_def->name = "unknown"; - m_item_definitions.insert(std::make_pair("unknown", unknown_def)); - - ItemDefinition* air_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; - ignore_def->type = ITEM_NODE; - ignore_def->name = "ignore"; - m_item_definitions.insert(std::make_pair("ignore", ignore_def)); -} + for (const TextureOverride& texture_override : overrides) { + if (m_item_definitions.find(texture_override.id) == m_item_definitions.end()) { + continue; // Ignore unknown item + } -/******************************************************************************/ -void CItemDefManager::registerItem(const ItemDefinition &def) -{ - verbosestream<<"ItemDefManager: registering \""<inventory_image = texture_override.texture; - verbosestream<<"ItemDefManager: setting alias "< "<wield_image = texture_override.texture; + } } -} - -/******************************************************************************/ -void CItemDefManager::serialize(std::ostream &os, u16 protocol_version) -{ - writeU8(os, 0); // version - u16 count = m_item_definitions.size(); - writeU16(os, count); - - for (std::map::const_iterator - it = m_item_definitions.begin(); - it != m_item_definitions.end(); ++it) { - 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()); + void clear() + { + for (auto &i : m_item_definitions) + { + delete i.second; + } + m_item_definitions.clear(); + m_aliases.clear(); + + // Add the four builtin items: + // "" is the hand + // "unknown" is returned whenever an undefined item + // is accessed (is also the unknown node) + // "air" is the air node + // "ignore" is the ignore node + + ItemDefinition* hand_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; + unknown_def->type = ITEM_NODE; + unknown_def->name = "unknown"; + m_item_definitions.insert(std::make_pair("unknown", unknown_def)); + + ItemDefinition* air_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; + ignore_def->type = ITEM_NODE; + ignore_def->name = "ignore"; + m_item_definitions.insert(std::make_pair("ignore", ignore_def)); } - - 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); + virtual void registerItem(const ItemDefinition &def) + { + 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"); + + 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 "< " << convert_to << std::endl); + m_aliases[name] = convert_to; + } } -} - -/******************************************************************************/ -void CItemDefManager::processQueue(IGameDef *gamedef) -{ -#ifndef SERVER - //NOTE this is only thread safe for ONE consumer thread! - while (!m_get_clientcached_queue.empty()) { + void serialize(std::ostream &os, u16 protocol_version) + { + writeU8(os, 0); // version + u16 count = m_item_definitions.size(); + writeU16(os, count); + + 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 << serializeString16(tmp_os.str()); + } - GetRequest - request = m_get_clientcached_queue.pop(); + writeU16(os, m_aliases.size()); - m_get_clientcached_queue.pushResult(request, - createClientCachedDirect(request.key, gamedef)); - } -#endif -} - -#ifndef SERVER -/******************************************************************************/ -void CItemDefManager::createNodeItemTexture(const std::string& name, - const ItemDefinition& def, INodeDefManager* nodedef, - ClientCached* cc, IGameDef* gamedef, ITextureSource* tsrc) const -{ - // Get node properties - content_t id = nodedef->getId(name); - const ContentFeatures& f = nodedef->get(id); - bool need_rtt_mesh = cc->inventory_texture == NULL; - // Keep this in sync with WieldMeshSceneNode::setItem() - bool need_wield_mesh = !(f.mesh_ptr[0] || f.drawtype == NDT_NORMAL - || f.drawtype == NDT_ALLFACES || f.drawtype == NDT_AIRLIKE); - scene::IMesh* node_mesh = NULL; - - if (need_rtt_mesh || need_wield_mesh) { - - u8 param1 = 0; - if (f.param_type == CPT_LIGHT) - param1 = 0xee; - - /* - Make a mesh from the node - */ - MeshMakeData mesh_make_data(gamedef, false); - u8 param2 = 0; - if (f.param_type_2 == CPT2_WALLMOUNTED) - param2 = 1; - - MapNode mesh_make_node(id, param1, param2); - mesh_make_data.fillSingleNode(&mesh_make_node); - MapBlockMesh mapblock_mesh(&mesh_make_data, v3s16(0, 0, 0)); - node_mesh = mapblock_mesh.getMesh(); - node_mesh->grab(); - video::SColor c(255, 255, 255, 255); - setMeshColor(node_mesh, c); - // scale and translate the mesh so it's a - // unit cube centered on the origin - scaleMesh(node_mesh, v3f(1.0 / BS, 1.0 / BS, 1.0 / BS)); - translateMesh(node_mesh, v3f(-1.0, -1.0, -1.0)); + for (const auto &it : m_aliases) { + os << serializeString16(it.first); + os << serializeString16(it.second); + } } - /* - Draw node mesh into a render target texture - */ - if (need_rtt_mesh) { - - TextureFromMeshParams params; - params.mesh = node_mesh; - params.dim.set(64, 64); - params.rtt_texture_name = "INVENTORY_" + def.name + "_RTT"; - params.delete_texture_on_shutdown = true; - params.camera_position.set(0, 1.0, -1.5); - params.camera_position.rotateXZBy(45); - params.camera_lookat.set(0, 0, 0); - // Set orthogonal projection - params.camera_projection_matrix.buildProjectionMatrixOrthoLH(1.65, - 1.65, 0, 100); - params.ambient_light.set(1.0, 0.2, 0.2, 0.2); - params.light_position.set(10, 100, -50); - params.light_color.set(1.0, 0.5, 0.5, 0.5); - params.light_radius = 1000; - cc->inventory_texture = tsrc->generateTextureFromMesh(params); - // render-to-target didn't work - if (cc->inventory_texture == NULL) { - - cc->inventory_texture = tsrc->getTexture(f.tiledef[0].name); + void deSerialize(std::istream &is) + { + // Clear everything + clear(); + // Deserialize + int version = readU8(is); + if(version != 0) + throw SerializationError("unsupported ItemDefManager version"); + u16 count = readU16(is); + for(u16 i=0; iwield_mesh = node_mesh; - cc->wield_mesh->grab(); - // no way reference count can be smaller than 2 in this place! - assert(cc->wield_mesh->getReferenceCount() >= 2); + void processQueue(IGameDef *gamedef) + { +#ifndef SERVER + //NOTE this is only thread safe for ONE consumer thread! + while(!m_get_clientcached_queue.empty()) + { + GetRequest + request = m_get_clientcached_queue.pop(); + + m_get_clientcached_queue.pushResult(request, + createClientCachedDirect(request.key, (Client *)gamedef)); + } +#endif } - if (node_mesh) - node_mesh->drop(); -} +private: + // Key is name + std::map m_item_definitions; + // Aliases + StringMap m_aliases; +#ifndef SERVER + // The id of the thread that is allowed to use irrlicht directly + std::thread::id m_main_thread; + // 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 m_clientcached; + // Queued clientcached fetches (to be processed by the main thread) + mutable RequestQueue m_get_clientcached_queue; #endif - -/******************************************************************************/ +}; IWritableItemDefManager* createItemDefManager() {