src/tooldef.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef TOOLDEF_HEADER
  21 #define TOOLDEF_HEADER
  22
  23 #include <string>
  24 #include <iostream>
  25
  26 struct ToolDiggingProperties
  27 {
  28         // time = basetime + sum(feature here * feature in MaterialProperties)
  29         float full_punch_interval;
  30         float basetime;
  31         float dt_weight;
  32         float dt_crackiness;
  33         float dt_crumbliness;
  34         float dt_cuttability;
  35         float basedurability;
  36         float dd_weight;
  37         float dd_crackiness;
  38         float dd_crumbliness;
  39         float dd_cuttability;
  40
  41         ToolDiggingProperties(float full_punch_interval_=2.0,
  42                         float a=0.75, float b=0, float c=0, float d=0, float e=0,
  43                         float f=50, float g=0, float h=0, float i=0, float j=0);
  44 };
  45
  46 struct ToolDefinition
  47 {
  48         std::string imagename;
  49         ToolDiggingProperties properties;
  50
  51         ToolDefinition(){}
  52         ToolDefinition(const std::string &imagename_,
  53                         ToolDiggingProperties properties_):
  54                 imagename(imagename_),
  55                 properties(properties_)
  56         {}
  57
  58         std::string dump();
  59         void serialize(std::ostream &os);
  60         void deSerialize(std::istream &is);
  61 };
  62
  63 class IToolDefManager
  64 {
  65 public:
  66         IToolDefManager(){}
  67         virtual ~IToolDefManager(){}
  68         virtual const ToolDefinition* getToolDefinition(const std::string &toolname) const=0;
  69         virtual std::string getImagename(const std::string &toolname) const =0;
  70         virtual ToolDiggingProperties getDiggingProperties(
  71                         const std::string &toolname) const =0;
  72         virtual std::string getAlias(const std::string &name) const =0;
  73
  74         virtual void serialize(std::ostream &os)=0;
  75 };
  76
  77 class IWritableToolDefManager : public IToolDefManager
  78 {
  79 public:
  80         IWritableToolDefManager(){}
  81         virtual ~IWritableToolDefManager(){}
  82         virtual const ToolDefinition* getToolDefinition(const std::string &toolname) const=0;
  83         virtual std::string getImagename(const std::string &toolname) const =0;
  84         virtual ToolDiggingProperties getDiggingProperties(
  85                         const std::string &toolname) const =0;
  86         virtual std::string getAlias(const std::string &name) const =0;
  87
  88         virtual bool registerTool(std::string toolname, const ToolDefinition &def)=0;
  89         virtual void clear()=0;
  90         // Set an alias so that entries named <name> will load as <convert_to>.
  91         // Alias is not set if <name> has already been defined.
  92         // Alias will be removed if <name> is defined at a later point of time.
  93         virtual void setAlias(const std::string &name,
  94                         const std::string &convert_to)=0;
  95
  96         virtual void serialize(std::ostream &os)=0;
  97         virtual void deSerialize(std::istream &is)=0;
  98 };
  99
 100 IWritableToolDefManager* createToolDefManager();
 101
 102 #endif
 103