3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2013 Kahrl <kahrl@gmx.net>
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.
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.
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.
25 #include "inventory.h"
27 #include "client/mapblock_mesh.h"
28 #include "client/mesh.h"
29 #include "client/wieldmesh.h"
30 #include "client/tile.h"
31 #include "client/client.h"
35 #include "util/serialize.h"
36 #include "util/container.h"
37 #include "util/thread.h"
44 ItemDefinition::ItemDefinition()
49 ItemDefinition::ItemDefinition(const ItemDefinition &def)
55 ItemDefinition& ItemDefinition::operator=(const ItemDefinition &def)
64 description = def.description;
65 inventory_image = def.inventory_image;
66 inventory_overlay = def.inventory_overlay;
67 wield_image = def.wield_image;
68 wield_overlay = def.wield_overlay;
69 wield_scale = def.wield_scale;
70 stack_max = def.stack_max;
72 liquids_pointable = def.liquids_pointable;
73 if(def.tool_capabilities)
75 tool_capabilities = new ToolCapabilities(
76 *def.tool_capabilities);
79 node_placement_prediction = def.node_placement_prediction;
80 sound_place = def.sound_place;
81 sound_place_failed = def.sound_place_failed;
83 palette_image = def.palette_image;
88 ItemDefinition::~ItemDefinition()
93 void ItemDefinition::resetInitial()
95 // Initialize pointers to NULL so reset() does not delete undefined pointers
96 tool_capabilities = NULL;
100 void ItemDefinition::reset()
105 inventory_image = "";
106 inventory_overlay = "";
110 color = video::SColor(0xFFFFFFFF);
111 wield_scale = v3f(1.0, 1.0, 1.0);
114 liquids_pointable = false;
115 delete tool_capabilities;
116 tool_capabilities = NULL;
118 sound_place = SimpleSoundSpec();
119 sound_place_failed = SimpleSoundSpec();
122 node_placement_prediction = "";
125 void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
127 // protocol_version >= 37
129 writeU8(os, version);
131 os << serializeString(name);
132 os << serializeString(description);
133 os << serializeString(inventory_image);
134 os << serializeString(wield_image);
135 writeV3F32(os, wield_scale);
136 writeS16(os, stack_max);
138 writeU8(os, liquids_pointable);
140 std::string tool_capabilities_s;
141 if (tool_capabilities) {
142 std::ostringstream tmp_os(std::ios::binary);
143 tool_capabilities->serialize(tmp_os, protocol_version);
144 tool_capabilities_s = tmp_os.str();
146 os << serializeString(tool_capabilities_s);
148 writeU16(os, groups.size());
149 for (const auto &group : groups) {
150 os << serializeString(group.first);
151 writeS16(os, group.second);
154 os << serializeString(node_placement_prediction);
156 // Version from ContentFeatures::serialize to keep in sync
157 sound_place.serialize(os, CONTENTFEATURES_VERSION);
158 sound_place_failed.serialize(os, CONTENTFEATURES_VERSION);
161 os << serializeString(palette_image);
162 writeARGB8(os, color);
163 os << serializeString(inventory_overlay);
164 os << serializeString(wield_overlay);
167 void ItemDefinition::deSerialize(std::istream &is)
173 int version = readU8(is);
175 throw SerializationError("unsupported ItemDefinition version");
177 type = (enum ItemType)readU8(is);
178 name = deSerializeString(is);
179 description = deSerializeString(is);
180 inventory_image = deSerializeString(is);
181 wield_image = deSerializeString(is);
182 wield_scale = readV3F32(is);
183 stack_max = readS16(is);
185 liquids_pointable = readU8(is);
187 std::string tool_capabilities_s = deSerializeString(is);
188 if (!tool_capabilities_s.empty()) {
189 std::istringstream tmp_is(tool_capabilities_s, std::ios::binary);
190 tool_capabilities = new ToolCapabilities;
191 tool_capabilities->deSerialize(tmp_is);
195 u32 groups_size = readU16(is);
196 for(u32 i=0; i<groups_size; i++){
197 std::string name = deSerializeString(is);
198 int value = readS16(is);
199 groups[name] = value;
202 node_placement_prediction = deSerializeString(is);
204 // Version from ContentFeatures::serialize to keep in sync
205 sound_place.deSerialize(is, CONTENTFEATURES_VERSION);
206 sound_place_failed.deSerialize(is, CONTENTFEATURES_VERSION);
209 palette_image = deSerializeString(is);
210 color = readARGB8(is);
211 inventory_overlay = deSerializeString(is);
212 wield_overlay = deSerializeString(is);
214 // If you add anything here, insert it primarily inside the try-catch
215 // block to not need to increase the version.
217 //} catch(SerializationError &e) {};
225 // SUGG: Support chains of aliases?
227 class CItemDefManager: public IWritableItemDefManager
232 video::ITexture *inventory_texture;
237 inventory_texture(NULL),
248 m_main_thread = std::this_thread::get_id();
252 virtual ~CItemDefManager()
255 const std::vector<ClientCached*> &values = m_clientcached.getValues();
256 for (ClientCached *cc : values) {
257 if (cc->wield_mesh.mesh)
258 cc->wield_mesh.mesh->drop();
263 for (auto &item_definition : m_item_definitions) {
264 delete item_definition.second;
266 m_item_definitions.clear();
268 virtual const ItemDefinition& get(const std::string &name_) const
270 // Convert name according to possible alias
271 std::string name = getAlias(name_);
272 // Get the definition
273 auto i = m_item_definitions.find(name);
274 if (i == m_item_definitions.cend())
275 i = m_item_definitions.find("unknown");
276 assert(i != m_item_definitions.cend());
279 virtual const std::string &getAlias(const std::string &name) const
281 auto it = m_aliases.find(name);
282 if (it != m_aliases.cend())
286 virtual void getAll(std::set<std::string> &result) const
289 for (const auto &item_definition : m_item_definitions) {
290 result.insert(item_definition.first);
293 for (const auto &alias : m_aliases) {
294 result.insert(alias.first);
297 virtual bool isKnown(const std::string &name_) const
299 // Convert name according to possible alias
300 std::string name = getAlias(name_);
301 // Get the definition
302 return m_item_definitions.find(name) != m_item_definitions.cend();
306 ClientCached* createClientCachedDirect(const std::string &name,
307 Client *client) const
309 infostream<<"Lazily creating item texture and mesh for \""
310 <<name<<"\""<<std::endl;
312 // This is not thread-safe
313 sanity_check(std::this_thread::get_id() == m_main_thread);
315 // Skip if already in cache
316 ClientCached *cc = NULL;
317 m_clientcached.get(name, &cc);
321 ITextureSource *tsrc = client->getTextureSource();
322 const ItemDefinition &def = get(name);
324 // Create new ClientCached
325 cc = new ClientCached();
327 // Create an inventory texture
328 cc->inventory_texture = NULL;
329 if (!def.inventory_image.empty())
330 cc->inventory_texture = tsrc->getTexture(def.inventory_image);
332 ItemStack item = ItemStack();
333 item.name = def.name;
335 getItemMesh(client, item, &(cc->wield_mesh));
337 cc->palette = tsrc->getPalette(def.palette_image);
340 m_clientcached.set(name, cc);
344 ClientCached* getClientCached(const std::string &name,
345 Client *client) const
347 ClientCached *cc = NULL;
348 m_clientcached.get(name, &cc);
352 if (std::this_thread::get_id() == m_main_thread) {
353 return createClientCachedDirect(name, client);
356 // We're gonna ask the result to be put into here
357 static ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
359 // Throw a request in
360 m_get_clientcached_queue.add(name, 0, 0, &result_queue);
363 // Wait result for a second
364 GetResult<std::string, ClientCached*, u8, u8>
365 result = result_queue.pop_front(1000);
367 if (result.key == name) {
371 } catch(ItemNotFoundException &e) {
372 errorstream << "Waiting for clientcached " << name
373 << " timed out." << std::endl;
374 return &m_dummy_clientcached;
377 // Get item inventory texture
378 virtual video::ITexture* getInventoryTexture(const std::string &name,
379 Client *client) const
381 ClientCached *cc = getClientCached(name, client);
384 return cc->inventory_texture;
386 // Get item wield mesh
387 virtual ItemMesh* getWieldMesh(const std::string &name,
388 Client *client) const
390 ClientCached *cc = getClientCached(name, client);
393 return &(cc->wield_mesh);
397 virtual Palette* getPalette(const std::string &name,
398 Client *client) const
400 ClientCached *cc = getClientCached(name, client);
406 virtual video::SColor getItemstackColor(const ItemStack &stack,
407 Client *client) const
409 // Look for direct color definition
410 const std::string &colorstring = stack.metadata.getString("color", 0);
411 video::SColor directcolor;
412 if (!colorstring.empty() && parseColorString(colorstring, directcolor, true))
414 // See if there is a palette
415 Palette *palette = getPalette(stack.name, client);
416 const std::string &index = stack.metadata.getString("palette_index", 0);
417 if (palette && !index.empty())
418 return (*palette)[mystoi(index, 0, 255)];
420 return get(stack.name).color;
423 void applyTextureOverrides(const std::vector<TextureOverride> &overrides)
425 infostream << "ItemDefManager::applyTextureOverrides(): Applying "
426 "overrides to textures" << std::endl;
428 for (const TextureOverride& texture_override : overrides) {
429 if (m_item_definitions.find(texture_override.id) == m_item_definitions.end()) {
430 continue; // Ignore unknown item
433 ItemDefinition* itemdef = m_item_definitions[texture_override.id];
435 if (texture_override.hasTarget(OverrideTarget::INVENTORY))
436 itemdef->inventory_image = texture_override.texture;
438 if (texture_override.hasTarget(OverrideTarget::WIELD))
439 itemdef->wield_image = texture_override.texture;
444 for (auto &i : m_item_definitions)
448 m_item_definitions.clear();
451 // Add the four builtin items:
453 // "unknown" is returned whenever an undefined item
454 // is accessed (is also the unknown node)
455 // "air" is the air node
456 // "ignore" is the ignore node
458 ItemDefinition* hand_def = new ItemDefinition;
460 hand_def->wield_image = "wieldhand.png";
461 hand_def->tool_capabilities = new ToolCapabilities;
462 m_item_definitions.insert(std::make_pair("", hand_def));
464 ItemDefinition* unknown_def = new ItemDefinition;
465 unknown_def->type = ITEM_NODE;
466 unknown_def->name = "unknown";
467 m_item_definitions.insert(std::make_pair("unknown", unknown_def));
469 ItemDefinition* air_def = new ItemDefinition;
470 air_def->type = ITEM_NODE;
471 air_def->name = "air";
472 m_item_definitions.insert(std::make_pair("air", air_def));
474 ItemDefinition* ignore_def = new ItemDefinition;
475 ignore_def->type = ITEM_NODE;
476 ignore_def->name = "ignore";
477 m_item_definitions.insert(std::make_pair("ignore", ignore_def));
479 virtual void registerItem(const ItemDefinition &def)
481 TRACESTREAM(<< "ItemDefManager: registering " << def.name << std::endl);
482 // Ensure that the "" item (the hand) always has ToolCapabilities
483 if (def.name.empty())
484 FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
486 if(m_item_definitions.count(def.name) == 0)
487 m_item_definitions[def.name] = new ItemDefinition(def);
489 *(m_item_definitions[def.name]) = def;
491 // Remove conflicting alias if it exists
492 bool alias_removed = (m_aliases.erase(def.name) != 0);
494 infostream<<"ItemDefManager: erased alias "<<def.name
495 <<" because item was defined"<<std::endl;
497 virtual void unregisterItem(const std::string &name)
499 verbosestream<<"ItemDefManager: unregistering \""<<name<<"\""<<std::endl;
501 delete m_item_definitions[name];
502 m_item_definitions.erase(name);
504 virtual void registerAlias(const std::string &name,
505 const std::string &convert_to)
507 if (m_item_definitions.find(name) == m_item_definitions.end()) {
508 TRACESTREAM(<< "ItemDefManager: setting alias " << name
509 << " -> " << convert_to << std::endl);
510 m_aliases[name] = convert_to;
513 void serialize(std::ostream &os, u16 protocol_version)
515 writeU8(os, 0); // version
516 u16 count = m_item_definitions.size();
519 for (const auto &it : m_item_definitions) {
520 ItemDefinition *def = it.second;
521 // Serialize ItemDefinition and write wrapped in a string
522 std::ostringstream tmp_os(std::ios::binary);
523 def->serialize(tmp_os, protocol_version);
524 os << serializeString(tmp_os.str());
527 writeU16(os, m_aliases.size());
529 for (const auto &it : m_aliases) {
530 os << serializeString(it.first);
531 os << serializeString(it.second);
534 void deSerialize(std::istream &is)
539 int version = readU8(is);
541 throw SerializationError("unsupported ItemDefManager version");
542 u16 count = readU16(is);
543 for(u16 i=0; i<count; i++)
545 // Deserialize a string and grab an ItemDefinition from it
546 std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
548 def.deSerialize(tmp_is);
552 u16 num_aliases = readU16(is);
553 for(u16 i=0; i<num_aliases; i++)
555 std::string name = deSerializeString(is);
556 std::string convert_to = deSerializeString(is);
557 registerAlias(name, convert_to);
560 void processQueue(IGameDef *gamedef)
563 //NOTE this is only thread safe for ONE consumer thread!
564 while(!m_get_clientcached_queue.empty())
566 GetRequest<std::string, ClientCached*, u8, u8>
567 request = m_get_clientcached_queue.pop();
569 m_get_clientcached_queue.pushResult(request,
570 createClientCachedDirect(request.key, (Client *)gamedef));
576 std::map<std::string, ItemDefinition*> m_item_definitions;
580 // The id of the thread that is allowed to use irrlicht directly
581 std::thread::id m_main_thread;
582 // A reference to this can be returned when nothing is found, to avoid NULLs
583 mutable ClientCached m_dummy_clientcached;
584 // Cached textures and meshes
585 mutable MutexedMap<std::string, ClientCached*> m_clientcached;
586 // Queued clientcached fetches (to be processed by the main thread)
587 mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
591 IWritableItemDefManager* createItemDefManager()
593 return new CItemDefManager();