3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2011 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 General Public License as published by
8 the Free Software Foundation; either version 2 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 General Public License for more details.
16 You should have received a copy of the GNU 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.
21 #ifndef ITEMDEF_HEADER
22 #define ITEMDEF_HEADER
24 #include "common_irrlicht.h"
29 struct ToolDiggingProperties;
49 std::string name; // "" = hand
50 std::string description; // Shown in tooltip.
55 std::string inventory_image; // Optional for nodes, mandatory for tools/craftitems
56 std::string wield_image; // If empty, inventory_image or mesh (only nodes) is used
60 Item stack and interaction properties
64 bool liquids_pointable;
65 // May be NULL. If non-NULL, deleted by destructor
66 ToolDiggingProperties *tool_digging_properties;
72 video::ITexture *inventory_texture;
73 scene::IMesh *wield_mesh;
80 ItemDefinition(const ItemDefinition &def);
81 ItemDefinition& operator=(const ItemDefinition &def);
84 void serialize(std::ostream &os) const;
85 void deSerialize(std::istream &is);
94 virtual ~IItemDefManager(){}
96 // Get item definition
97 virtual const ItemDefinition& get(const std::string &name) const=0;
98 // Get alias definition
99 virtual std::string getAlias(const std::string &name) const=0;
100 // Get set of all defined item names and aliases
101 virtual std::set<std::string> getAll() const=0;
102 // Check if item is known
103 virtual bool isKnown(const std::string &name) const=0;
105 virtual void serialize(std::ostream &os)=0;
108 class IWritableItemDefManager : public IItemDefManager
111 IWritableItemDefManager(){}
112 virtual ~IWritableItemDefManager(){}
114 // Get item definition
115 virtual const ItemDefinition& get(const std::string &name) const=0;
116 // Get alias definition
117 virtual std::string getAlias(const std::string &name) const=0;
118 // Get set of all defined item names and aliases
119 virtual std::set<std::string> getAll() const=0;
120 // Check if item is known
121 virtual bool isKnown(const std::string &name) const=0;
123 // Remove all registered item and node definitions and aliases
124 // Then re-add the builtin item definitions
125 virtual void clear()=0;
126 // Register item definition
127 virtual void registerItem(const ItemDefinition &def)=0;
128 // Set an alias so that items named <name> will load as <convert_to>.
129 // Alias is not set if <name> has already been defined.
130 // Alias will be removed if <name> is defined at a later point of time.
131 virtual void registerAlias(const std::string &name,
132 const std::string &convert_to)=0;
135 Update inventory textures and wield meshes to latest
136 return values of ITextureSource and INodeDefManager.
137 Call after updating the texture atlas of a texture source.
139 virtual void updateTexturesAndMeshes(IGameDef *gamedef)=0;
141 virtual void serialize(std::ostream &os)=0;
142 virtual void deSerialize(std::istream &is)=0;
145 IWritableItemDefManager* createItemDefManager();