/*
-Minetest-c55
-Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
-Copyright (C) 2011 Kahrl <kahrl@gmx.net>
+Minetest
+Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+Copyright (C) 2013 Kahrl <kahrl@gmx.net>
This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#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 "tile.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 "utility.h"
+#include "settings.h"
+#include "util/serialize.h"
+#include "util/container.h"
+#include "util/thread.h"
#include <map>
#include <set>
name = def.name;
description = def.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;
*def.tool_capabilities);
}
groups = def.groups;
-#ifndef SERVER
- inventory_texture = def.inventory_texture;
- if(def.wield_mesh)
- {
- wield_mesh = def.wield_mesh;
- wield_mesh->grab();
- }
-#endif
+ node_placement_prediction = def.node_placement_prediction;
+ 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;
}
{
// Initialize pointers to NULL so reset() does not delete undefined pointers
tool_capabilities = NULL;
-#ifndef SERVER
- inventory_texture = NULL;
- wield_mesh = NULL;
-#endif
reset();
}
name = "";
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;
-#ifndef SERVER
- inventory_texture = NULL;
- if(wield_mesh)
- {
- wield_mesh->drop();
- wield_mesh = NULL;
- }
-#endif
+ node_placement_prediction = "";
}
-void ItemDefinition::serialize(std::ostream &os) const
+void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
{
- writeU8(os, 1); // version
+ // 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 << serializeString(name);
+ os << serializeString(description);
+ os << serializeString(inventory_image);
+ os << serializeString(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);
+ tool_capabilities->serialize(tmp_os, protocol_version);
tool_capabilities_s = tmp_os.str();
}
- os<<serializeString(tool_capabilities_s);
+ os << serializeString(tool_capabilities_s);
+
writeU16(os, groups.size());
- for(std::map<std::string, int>::const_iterator
- i = groups.begin(); i != groups.end(); i++){
- os<<serializeString(i->first);
- writeS16(os, i->second);
+ for (const auto &group : groups) {
+ os << serializeString(group.first);
+ writeS16(os, group.second);
}
+
+ os << serializeString(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);
+ writeARGB8(os, color);
+ os << serializeString(inventory_overlay);
+ os << serializeString(wield_overlay);
}
void ItemDefinition::deSerialize(std::istream &is)
// Deserialize
int version = readU8(is);
- if(version != 1)
+ 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);
+ 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())
- {
+ 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++){
int value = readS16(is);
groups[name] = value;
}
+
+ node_placement_prediction = deSerializeString(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);
+ color = readARGB8(is);
+ inventory_overlay = deSerializeString(is);
+ wield_overlay = deSerializeString(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) {};
}
+
/*
CItemDefManager
*/
class CItemDefManager: public IWritableItemDefManager
{
+#ifndef SERVER
+ struct ClientCached
+ {
+ video::ITexture *inventory_texture;
+ ItemMesh wield_mesh;
+ Palette *palette;
+
+ ClientCached():
+ inventory_texture(NULL),
+ palette(NULL)
+ {}
+ };
+#endif
+
public:
CItemDefManager()
{
+
+#ifndef SERVER
+ m_main_thread = std::this_thread::get_id();
+#endif
clear();
}
virtual ~CItemDefManager()
{
+#ifndef SERVER
+ const std::vector<ClientCached*> &values = m_clientcached.getValues();
+ for (ClientCached *cc : values) {
+ if (cc->wield_mesh.mesh)
+ cc->wield_mesh.mesh->drop();
+ delete cc;
+ }
+
+#endif
+ for (auto &item_definition : m_item_definitions) {
+ delete item_definition.second;
+ }
+ m_item_definitions.clear();
}
virtual const ItemDefinition& get(const std::string &name_) const
{
assert(i != m_item_definitions.end());
return *(i->second);
}
- virtual std::string getAlias(const std::string &name) const
+ virtual const std::string &getAlias(const std::string &name) const
{
- std::map<std::string, std::string>::const_iterator i;
- i = m_aliases.find(name);
- if(i != m_aliases.end())
- return i->second;
+ StringMap::const_iterator it = m_aliases.find(name);
+ if (it != m_aliases.end())
+ return it->second;
return name;
}
- virtual std::set<std::string> getAll() const
+ virtual void getAll(std::set<std::string> &result) const
{
- std::set<std::string> result;
- for(std::map<std::string, ItemDefinition*>::const_iterator
- i = m_item_definitions.begin();
- i != m_item_definitions.end(); i++)
- {
- result.insert(i->first);
+ result.clear();
+ for (const auto &item_definition : m_item_definitions) {
+ result.insert(item_definition.first);
}
- for(std::map<std::string, std::string>::const_iterator
- i = m_aliases.begin();
- i != m_aliases.end(); i++)
- {
- result.insert(i->first);
+
+ for (const auto &alias : m_aliases) {
+ result.insert(alias.first);
}
- return result;
}
virtual bool isKnown(const std::string &name_) const
{
std::map<std::string, ItemDefinition*>::const_iterator i;
return m_item_definitions.find(name) != m_item_definitions.end();
}
+#ifndef SERVER
+public:
+ ClientCached* createClientCachedDirect(const std::string &name,
+ Client *client) const
+ {
+ 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);
+
+ // Skip if already in cache
+ ClientCached *cc = NULL;
+ m_clientcached.get(name, &cc);
+ if(cc)
+ return cc;
+
+ ITextureSource *tsrc = client->getTextureSource();
+ const ItemDefinition &def = get(name);
+
+ // Create new ClientCached
+ cc = new ClientCached();
+
+ // Create an inventory texture
+ cc->inventory_texture = NULL;
+ if (!def.inventory_image.empty())
+ cc->inventory_texture = tsrc->getTexture(def.inventory_image);
+
+ ItemStack item = ItemStack();
+ item.name = def.name;
+
+ getItemMesh(client, item, &(cc->wield_mesh));
+
+ cc->palette = tsrc->getPalette(def.palette_image);
+
+ // Put in cache
+ m_clientcached.set(name, cc);
+
+ return cc;
+ }
+ 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<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;
+ }
+ }
+ // 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 palette
+ virtual Palette* getPalette(const std::string &name,
+ Client *client) const
+ {
+ ClientCached *cc = getClientCached(name, client);
+ if(!cc)
+ return NULL;
+ return cc->palette;
+ }
+
+ 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 clear()
{
for(std::map<std::string, ItemDefinition*>::const_iterator
i = m_item_definitions.begin();
- i != m_item_definitions.end(); i++)
+ i != m_item_definitions.end(); ++i)
{
delete i->second;
}
// Add the four builtin items:
// "" is the hand
- // "unknown" is returned whenever an undefined item is accessed
+ // "unknown" is returned whenever an undefined item
+ // is accessed (is also the unknown node)
// "air" is the air node
// "ignore" is the ignore node
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));
}
virtual void registerItem(const ItemDefinition &def)
{
- infostream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
+ verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
// Ensure that the "" item (the hand) always has ToolCapabilities
- if(def.name == "")
- assert(def.tool_capabilities != NULL);
+ if (def.name.empty())
+ FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
- m_item_definitions[def.name] = new ItemDefinition(def);
+ 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);
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;
+
+ delete m_item_definitions[name];
+ m_item_definitions.erase(name);
+ }
virtual void registerAlias(const std::string &name,
const std::string &convert_to)
{
- if(m_item_definitions.find(name) == m_item_definitions.end())
- {
- infostream<<"ItemDefManager: setting alias "<<name
+ if (m_item_definitions.find(name) == m_item_definitions.end()) {
+ verbosestream<<"ItemDefManager: setting alias "<<name
<<" -> "<<convert_to<<std::endl;
m_aliases[name] = convert_to;
}
}
-
- virtual void updateTexturesAndMeshes(IGameDef *gamedef)
- {
-#ifndef SERVER
- infostream<<"ItemDefManager::updateTexturesAndMeshes(): Updating "
- <<"textures and meshes in item definitions"<<std::endl;
-
- ITextureSource *tsrc = gamedef->getTextureSource();
- INodeDefManager *nodedef = gamedef->getNodeDefManager();
- IrrlichtDevice *device = tsrc->getDevice();
- video::IVideoDriver *driver = device->getVideoDriver();
-
- for(std::map<std::string, ItemDefinition*>::iterator
- i = m_item_definitions.begin();
- i != m_item_definitions.end(); i++)
- {
- ItemDefinition *def = i->second;
-
- bool need_node_mesh = false;
-
- // Create an inventory texture
- def->inventory_texture = NULL;
- if(def->inventory_image != "")
- {
- def->inventory_texture = tsrc->getTextureRaw(def->inventory_image);
- }
- else if(def->type == ITEM_NODE)
- {
- need_node_mesh = true;
- }
-
- // Create a wield mesh
- if(def->wield_mesh != NULL)
- {
- def->wield_mesh->drop();
- def->wield_mesh = NULL;
- }
- if(def->type == ITEM_NODE && def->wield_image == "")
- {
- need_node_mesh = true;
- }
- else if(def->wield_image != "" || def->inventory_image != "")
- {
- // Extrude the wield image into a mesh
-
- std::string imagename;
- if(def->wield_image != "")
- imagename = def->wield_image;
- else
- imagename = def->inventory_image;
-
- def->wield_mesh = createExtrudedMesh(
- tsrc->getTextureRaw(imagename),
- driver,
- def->wield_scale * v3f(40.0, 40.0, 4.0));
- if(def->wield_mesh == NULL)
- {
- infostream<<"ItemDefManager: WARNING: "
- <<"updateTexturesAndMeshes(): "
- <<"Unable to create extruded mesh for item "
- <<def->name<<std::endl;
- }
- }
-
- if(need_node_mesh)
- {
- /*
- Get node properties
- */
- content_t id = nodedef->getId(def->name);
- const ContentFeatures &f = nodedef->get(id);
-
- /*
- Make a mesh from the node
- */
- MeshMakeData mesh_make_data;
- MapNode mesh_make_node(
- id,
- (f.param_type == CPT_LIGHT) ? 0xee : 0,
- 0);
- mesh_make_data.fillSingleNode(1000, &mesh_make_node);
- scene::IMesh *node_mesh =
- makeMapBlockMesh(&mesh_make_data, gamedef);
- setMeshColor(node_mesh, video::SColor(255, 255, 255, 255));
-
- /*
- 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));
-
- /*
- Draw node mesh into a render target texture
- */
- if(def->inventory_texture == NULL && node_mesh != NULL)
- {
- core::dimension2d<u32> dim(64,64);
- std::string rtt_texture_name = "INVENTORY_"
- + def->name + "_RTT";
- v3f camera_position(0, 1.0, -1.5);
- camera_position.rotateXZBy(45);
- v3f camera_lookat(0, 0, 0);
- core::CMatrix4<f32> camera_projection_matrix;
- // Set orthogonal projection
- camera_projection_matrix.buildProjectionMatrixOrthoLH(
- 1.65, 1.65, 0, 100);
-
- video::SColorf ambient_light(0.2,0.2,0.2);
- v3f light_position(10, 100, -50);
- video::SColorf light_color(0.5,0.5,0.5);
- f32 light_radius = 1000;
-
- def->inventory_texture = generateTextureFromMesh(
- node_mesh, device, dim, rtt_texture_name,
- camera_position,
- camera_lookat,
- camera_projection_matrix,
- ambient_light,
- light_position,
- light_color,
- light_radius);
-
- // render-to-target didn't work
- if(def->inventory_texture == NULL)
- {
- def->inventory_texture =
- tsrc->getTextureRaw(f.tname_tiles[0]);
- }
- }
-
- /*
- Use the node mesh as the wield mesh
- */
- if(def->wield_mesh == NULL && node_mesh != NULL)
- {
- // Scale to proper wield mesh proportions
- scaleMesh(node_mesh, v3f(30.0, 30.0, 30.0)
- * def->wield_scale);
- def->wield_mesh = node_mesh;
- def->wield_mesh->grab();
- }
-
-
- if(node_mesh != NULL)
- node_mesh->drop();
- }
- }
-#endif
- }
- void serialize(std::ostream &os)
+ void serialize(std::ostream &os, u16 protocol_version)
{
writeU8(os, 0); // version
u16 count = m_item_definitions.size();
writeU16(os, count);
- for(std::map<std::string, ItemDefinition*>::const_iterator
- i = m_item_definitions.begin();
- i != m_item_definitions.end(); i++)
- {
- ItemDefinition *def = i->second;
+
+ for (std::map<std::string, ItemDefinition *>::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);
- os<<serializeString(tmp_os.str());
+ def->serialize(tmp_os, protocol_version);
+ os << serializeString(tmp_os.str());
}
+
writeU16(os, m_aliases.size());
- for(std::map<std::string, std::string>::const_iterator
- i = m_aliases.begin(); i != m_aliases.end(); i++)
- {
- os<<serializeString(i->first);
- os<<serializeString(i->second);
+
+ for (StringMap::const_iterator
+ it = m_aliases.begin();
+ it != m_aliases.end(); ++it) {
+ os << serializeString(it->first);
+ os << serializeString(it->second);
}
}
void deSerialize(std::istream &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));
+ }
+#endif
+ }
private:
// Key is name
std::map<std::string, ItemDefinition*> m_item_definitions;
// Aliases
- std::map<std::string, std::string> m_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<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;
+#endif
};
IWritableItemDefManager* createItemDefManager()
{
return new CItemDefManager();
}
-