src/itemdef.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2011 Kahrl <kahrl@gmx.net>
   5
   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.
  10
  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.
  15
  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.
  19 */
  20
  21 #ifndef ITEMDEF_HEADER
  22 #define ITEMDEF_HEADER
  23
  24 #include "common_irrlicht.h"
  25 #include <string>
  26 #include <iostream>
  27 #include <set>
  28 #include "itemgroup.h"
  29 class IGameDef;
  30 struct ToolCapabilities;
  31
  32 /*
  33         Base item definition
  34 */
  35
  36 enum ItemType
  37 {
  38         ITEM_NONE,
  39         ITEM_NODE,
  40         ITEM_CRAFT,
  41         ITEM_TOOL,
  42 };
  43
  44 struct ItemDefinition
  45 {
  46         /*
  47                 Basic item properties
  48         */
  49         ItemType type;
  50         std::string name; // "" = hand
  51         std::string description; // Shown in tooltip.
  52
  53         /*
  54                 Visual properties
  55         */
  56         std::string inventory_image; // Optional for nodes, mandatory for tools/craftitems
  57         std::string wield_image; // If empty, inventory_image or mesh (only nodes) is used
  58         v3f wield_scale;
  59
  60         /*
  61                 Item stack and interaction properties
  62         */
  63         s16 stack_max;
  64         bool usable;
  65         bool liquids_pointable;
  66         // May be NULL. If non-NULL, deleted by destructor
  67         ToolCapabilities *tool_capabilities;
  68         ItemGroupList groups;
  69
  70         // Client shall immediately place this node when player places the item.
  71         // Server will update the precise end result a moment later.
  72         // "" = no prediction
  73         std::string node_placement_prediction;
  74
  75         /*
  76                 Cached stuff
  77         */
  78 #ifndef SERVER
  79         video::ITexture *inventory_texture;
  80         scene::IMesh *wield_mesh;
  81 #endif
  82
  83         /*
  84                 Some helpful methods
  85         */
  86         ItemDefinition();
  87         ItemDefinition(const ItemDefinition &def);
  88         ItemDefinition& operator=(const ItemDefinition &def);
  89         ~ItemDefinition();
  90         void reset();
  91         void serialize(std::ostream &os) const;
  92         void deSerialize(std::istream &is);
  93 private:
  94         void resetInitial();
  95 };
  96
  97 class IItemDefManager
  98 {
  99 public:
 100         IItemDefManager(){}
 101         virtual ~IItemDefManager(){}
 102
 103         // Get item definition
 104         virtual const ItemDefinition& get(const std::string &name) const=0;
 105         // Get alias definition
 106         virtual std::string getAlias(const std::string &name) const=0;
 107         // Get set of all defined item names and aliases
 108         virtual std::set<std::string> getAll() const=0;
 109         // Check if item is known
 110         virtual bool isKnown(const std::string &name) const=0;
 111
 112         virtual void serialize(std::ostream &os)=0;
 113 };
 114
 115 class IWritableItemDefManager : public IItemDefManager
 116 {
 117 public:
 118         IWritableItemDefManager(){}
 119         virtual ~IWritableItemDefManager(){}
 120
 121         // Get item definition
 122         virtual const ItemDefinition& get(const std::string &name) const=0;
 123         // Get alias definition
 124         virtual std::string getAlias(const std::string &name) const=0;
 125         // Get set of all defined item names and aliases
 126         virtual std::set<std::string> getAll() const=0;
 127         // Check if item is known
 128         virtual bool isKnown(const std::string &name) const=0;
 129
 130         // Remove all registered item and node definitions and aliases
 131         // Then re-add the builtin item definitions
 132         virtual void clear()=0;
 133         // Register item definition
 134         virtual void registerItem(const ItemDefinition &def)=0;
 135         // Set an alias so that items named <name> will load as <convert_to>.
 136         // Alias is not set if <name> has already been defined.
 137         // Alias will be removed if <name> is defined at a later point of time.
 138         virtual void registerAlias(const std::string &name,
 139                         const std::string &convert_to)=0;
 140
 141         /*
 142                 Update inventory textures and wield meshes to latest
 143                 return values of ITextureSource and INodeDefManager.
 144                 Call after updating the texture atlas of a texture source.
 145         */
 146         virtual void updateTexturesAndMeshes(IGameDef *gamedef)=0;
 147
 148         virtual void serialize(std::ostream &os)=0;
 149         virtual void deSerialize(std::istream &is)=0;
 150 };
 151
 152 IWritableItemDefManager* createItemDefManager();
 153
 154 #endif