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 "mapblock_mesh.h"
29 #include "wieldmesh.h"
30 #include "client/tile.h"
35 #include "util/serialize.h"
36 #include "util/container.h"
37 #include "util/thread.h"
48 ItemDefinition::ItemDefinition()
53 ItemDefinition::ItemDefinition(const ItemDefinition &def)
59 ItemDefinition& ItemDefinition::operator=(const ItemDefinition &def)
68 description = def.description;
69 inventory_image = def.inventory_image;
70 wield_image = def.wield_image;
71 wield_scale = def.wield_scale;
72 stack_max = def.stack_max;
74 liquids_pointable = def.liquids_pointable;
75 if(def.tool_capabilities)
77 tool_capabilities = new ToolCapabilities(
78 *def.tool_capabilities);
81 node_placement_prediction = def.node_placement_prediction;
82 sound_place = def.sound_place;
83 sound_place_failed = def.sound_place_failed;
85 palette_image = def.palette_image;
90 ItemDefinition::~ItemDefinition()
95 void ItemDefinition::resetInitial()
97 // Initialize pointers to NULL so reset() does not delete undefined pointers
98 tool_capabilities = NULL;
102 void ItemDefinition::reset()
107 inventory_image = "";
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
128 writeU8(os, 3); // version (proto > 20)
130 os << serializeString(name);
131 os << serializeString(description);
132 os << serializeString(inventory_image);
133 os << serializeString(wield_image);
134 writeV3F1000(os, wield_scale);
135 writeS16(os, stack_max);
137 writeU8(os, liquids_pointable);
138 std::string tool_capabilities_s = "";
139 if(tool_capabilities){
140 std::ostringstream tmp_os(std::ios::binary);
141 tool_capabilities->serialize(tmp_os, protocol_version);
142 tool_capabilities_s = tmp_os.str();
144 os << serializeString(tool_capabilities_s);
145 writeU16(os, groups.size());
146 for (ItemGroupList::const_iterator
147 i = groups.begin(); i != groups.end(); ++i){
148 os << serializeString(i->first);
149 writeS16(os, i->second);
151 os << serializeString(node_placement_prediction);
152 os << serializeString(sound_place.name);
153 writeF1000(os, sound_place.gain);
154 writeF1000(os, range);
155 os << serializeString(sound_place_failed.name);
156 writeF1000(os, sound_place_failed.gain);
157 os << serializeString(palette_image);
158 writeU32(os, color.color);
161 void ItemDefinition::deSerialize(std::istream &is)
167 int version = readU8(is);
168 if(version < 1 || version > 3)
169 throw SerializationError("unsupported ItemDefinition version");
170 type = (enum ItemType)readU8(is);
171 name = deSerializeString(is);
172 description = deSerializeString(is);
173 inventory_image = deSerializeString(is);
174 wield_image = deSerializeString(is);
175 wield_scale = readV3F1000(is);
176 stack_max = readS16(is);
178 liquids_pointable = readU8(is);
179 std::string tool_capabilities_s = deSerializeString(is);
180 if(!tool_capabilities_s.empty())
182 std::istringstream tmp_is(tool_capabilities_s, std::ios::binary);
183 tool_capabilities = new ToolCapabilities;
184 tool_capabilities->deSerialize(tmp_is);
187 u32 groups_size = readU16(is);
188 for(u32 i=0; i<groups_size; i++){
189 std::string name = deSerializeString(is);
190 int value = readS16(is);
191 groups[name] = value;
194 // We cant be sure that node_placement_prediction is send in version 1
196 node_placement_prediction = deSerializeString(is);
197 }catch(SerializationError &e) {};
198 // Set the old default sound
199 sound_place.name = "default_place_node";
200 sound_place.gain = 0.5;
201 } else if(version >= 2) {
202 node_placement_prediction = deSerializeString(is);
203 //deserializeSimpleSoundSpec(sound_place, is);
204 sound_place.name = deSerializeString(is);
205 sound_place.gain = readF1000(is);
208 range = readF1000(is);
210 // If you add anything here, insert it primarily inside the try-catch
211 // block to not need to increase the version.
213 sound_place_failed.name = deSerializeString(is);
214 sound_place_failed.gain = readF1000(is);
215 palette_image = deSerializeString(is);
216 color.set(readU32(is));
217 } catch(SerializationError &e) {};
224 // SUGG: Support chains of aliases?
226 class CItemDefManager: public IWritableItemDefManager
231 video::ITexture *inventory_texture;
236 inventory_texture(NULL),
248 m_main_thread = thr_get_current_thread_id();
252 virtual ~CItemDefManager()
255 const std::vector<ClientCached*> &values = m_clientcached.getValues();
256 for(std::vector<ClientCached*>::const_iterator
257 i = values.begin(); i != values.end(); ++i)
259 ClientCached *cc = *i;
260 if (cc->wield_mesh.mesh)
261 cc->wield_mesh.mesh->drop();
266 for (std::map<std::string, ItemDefinition*>::iterator iter =
267 m_item_definitions.begin(); iter != m_item_definitions.end();
271 m_item_definitions.clear();
273 virtual const ItemDefinition& get(const std::string &name_) const
275 // Convert name according to possible alias
276 std::string name = getAlias(name_);
277 // Get the definition
278 std::map<std::string, ItemDefinition*>::const_iterator i;
279 i = m_item_definitions.find(name);
280 if(i == m_item_definitions.end())
281 i = m_item_definitions.find("unknown");
282 assert(i != m_item_definitions.end());
285 virtual const std::string &getAlias(const std::string &name) const
287 StringMap::const_iterator it = m_aliases.find(name);
288 if (it != m_aliases.end())
292 virtual void getAll(std::set<std::string> &result) const
295 for(std::map<std::string, ItemDefinition *>::const_iterator
296 it = m_item_definitions.begin();
297 it != m_item_definitions.end(); ++it) {
298 result.insert(it->first);
300 for (StringMap::const_iterator
301 it = m_aliases.begin();
302 it != m_aliases.end(); ++it) {
303 result.insert(it->first);
306 virtual bool isKnown(const std::string &name_) const
308 // Convert name according to possible alias
309 std::string name = getAlias(name_);
310 // Get the definition
311 std::map<std::string, ItemDefinition*>::const_iterator i;
312 return m_item_definitions.find(name) != m_item_definitions.end();
316 ClientCached* createClientCachedDirect(const std::string &name,
317 Client *client) const
319 infostream<<"Lazily creating item texture and mesh for \""
320 <<name<<"\""<<std::endl;
322 // This is not thread-safe
323 sanity_check(thr_is_current_thread(m_main_thread));
325 // Skip if already in cache
326 ClientCached *cc = NULL;
327 m_clientcached.get(name, &cc);
331 ITextureSource *tsrc = client->getTextureSource();
332 const ItemDefinition &def = get(name);
334 // Create new ClientCached
335 cc = new ClientCached();
337 // Create an inventory texture
338 cc->inventory_texture = NULL;
339 if(def.inventory_image != "")
340 cc->inventory_texture = tsrc->getTexture(def.inventory_image);
342 ItemStack item = ItemStack();
343 item.name = def.name;
345 getItemMesh(client, item, &(cc->wield_mesh));
347 cc->palette = tsrc->getPalette(def.palette_image);
350 m_clientcached.set(name, cc);
354 ClientCached* getClientCached(const std::string &name,
355 Client *client) const
357 ClientCached *cc = NULL;
358 m_clientcached.get(name, &cc);
362 if(thr_is_current_thread(m_main_thread))
364 return createClientCachedDirect(name, client);
368 // We're gonna ask the result to be put into here
369 static ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
371 // Throw a request in
372 m_get_clientcached_queue.add(name, 0, 0, &result_queue);
375 // Wait result for a second
376 GetResult<std::string, ClientCached*, u8, u8>
377 result = result_queue.pop_front(1000);
379 if (result.key == name) {
384 catch(ItemNotFoundException &e)
386 errorstream<<"Waiting for clientcached " << name << " timed out."<<std::endl;
387 return &m_dummy_clientcached;
391 // Get item inventory texture
392 virtual video::ITexture* getInventoryTexture(const std::string &name,
393 Client *client) const
395 ClientCached *cc = getClientCached(name, client);
398 return cc->inventory_texture;
400 // Get item wield mesh
401 virtual ItemMesh* getWieldMesh(const std::string &name,
402 Client *client) const
404 ClientCached *cc = getClientCached(name, client);
407 return &(cc->wield_mesh);
411 virtual Palette* getPalette(const std::string &name,
412 Client *client) const
414 ClientCached *cc = getClientCached(name, client);
420 virtual video::SColor getItemstackColor(const ItemStack &stack,
421 Client *client) const
423 // Look for direct color definition
424 const std::string &colorstring = stack.metadata.getString("color", 0);
425 video::SColor directcolor;
426 if ((colorstring != "")
427 && parseColorString(colorstring, directcolor, true))
429 // See if there is a palette
430 Palette *palette = getPalette(stack.name, client);
431 const std::string &index = stack.metadata.getString("palette_index", 0);
432 if ((palette != NULL) && (index != ""))
433 return (*palette)[mystoi(index, 0, 255)];
435 return get(stack.name).color;
440 for(std::map<std::string, ItemDefinition*>::const_iterator
441 i = m_item_definitions.begin();
442 i != m_item_definitions.end(); ++i)
446 m_item_definitions.clear();
449 // Add the four builtin items:
451 // "unknown" is returned whenever an undefined item
452 // is accessed (is also the unknown node)
453 // "air" is the air node
454 // "ignore" is the ignore node
456 ItemDefinition* hand_def = new ItemDefinition;
458 hand_def->wield_image = "wieldhand.png";
459 hand_def->tool_capabilities = new ToolCapabilities;
460 m_item_definitions.insert(std::make_pair("", hand_def));
462 ItemDefinition* unknown_def = new ItemDefinition;
463 unknown_def->type = ITEM_NODE;
464 unknown_def->name = "unknown";
465 m_item_definitions.insert(std::make_pair("unknown", unknown_def));
467 ItemDefinition* air_def = new ItemDefinition;
468 air_def->type = ITEM_NODE;
469 air_def->name = "air";
470 m_item_definitions.insert(std::make_pair("air", air_def));
472 ItemDefinition* ignore_def = new ItemDefinition;
473 ignore_def->type = ITEM_NODE;
474 ignore_def->name = "ignore";
475 m_item_definitions.insert(std::make_pair("ignore", ignore_def));
477 virtual void registerItem(const ItemDefinition &def)
479 verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
480 // Ensure that the "" item (the hand) always has ToolCapabilities
482 FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
484 if(m_item_definitions.count(def.name) == 0)
485 m_item_definitions[def.name] = new ItemDefinition(def);
487 *(m_item_definitions[def.name]) = def;
489 // Remove conflicting alias if it exists
490 bool alias_removed = (m_aliases.erase(def.name) != 0);
492 infostream<<"ItemDefManager: erased alias "<<def.name
493 <<" because item was defined"<<std::endl;
495 virtual void unregisterItem(const std::string &name)
497 verbosestream<<"ItemDefManager: unregistering \""<<name<<"\""<<std::endl;
499 delete m_item_definitions[name];
500 m_item_definitions.erase(name);
502 virtual void registerAlias(const std::string &name,
503 const std::string &convert_to)
505 if (m_item_definitions.find(name) == m_item_definitions.end()) {
506 verbosestream<<"ItemDefManager: setting alias "<<name
507 <<" -> "<<convert_to<<std::endl;
508 m_aliases[name] = convert_to;
511 void serialize(std::ostream &os, u16 protocol_version)
513 writeU8(os, 0); // version
514 u16 count = m_item_definitions.size();
517 for (std::map<std::string, ItemDefinition *>::const_iterator
518 it = m_item_definitions.begin();
519 it != m_item_definitions.end(); ++it) {
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 (StringMap::const_iterator
530 it = m_aliases.begin();
531 it != m_aliases.end(); ++it) {
532 os << serializeString(it->first);
533 os << serializeString(it->second);
536 void deSerialize(std::istream &is)
541 int version = readU8(is);
543 throw SerializationError("unsupported ItemDefManager version");
544 u16 count = readU16(is);
545 for(u16 i=0; i<count; i++)
547 // Deserialize a string and grab an ItemDefinition from it
548 std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
550 def.deSerialize(tmp_is);
554 u16 num_aliases = readU16(is);
555 for(u16 i=0; i<num_aliases; i++)
557 std::string name = deSerializeString(is);
558 std::string convert_to = deSerializeString(is);
559 registerAlias(name, convert_to);
562 void processQueue(IGameDef *gamedef)
565 //NOTE this is only thread safe for ONE consumer thread!
566 while(!m_get_clientcached_queue.empty())
568 GetRequest<std::string, ClientCached*, u8, u8>
569 request = m_get_clientcached_queue.pop();
571 m_get_clientcached_queue.pushResult(request,
572 createClientCachedDirect(request.key, (Client *)gamedef));
578 std::map<std::string, ItemDefinition*> m_item_definitions;
582 // The id of the thread that is allowed to use irrlicht directly
583 threadid_t m_main_thread;
584 // A reference to this can be returned when nothing is found, to avoid NULLs
585 mutable ClientCached m_dummy_clientcached;
586 // Cached textures and meshes
587 mutable MutexedMap<std::string, ClientCached*> m_clientcached;
588 // Queued clientcached fetches (to be processed by the main thread)
589 mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
593 IWritableItemDefManager* createItemDefManager()
595 return new CItemDefManager();