src/nodedef.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 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 Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser 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 NODEDEF_HEADER
  21 #define NODEDEF_HEADER
  22
  23 #include "irrlichttypes_bloated.h"
  24 #include <string>
  25 #include <iostream>
  26 #include <map>
  27 #include <list>
  28 #include "mapnode.h"
  29 #ifndef SERVER
  30 #include "tile.h"
  31 #endif
  32 #include "itemgroup.h"
  33 #include "sound.h" // SimpleSoundSpec
  34 #include "constants.h" // BS
  35
  36 class IItemDefManager;
  37 class ITextureSource;
  38 class IGameDef;
  39
  40 typedef std::list<std::pair<content_t, int> > GroupItems;
  41
  42 enum ContentParamType
  43 {
  44         CPT_NONE,
  45         CPT_LIGHT,
  46 };
  47
  48 enum ContentParamType2
  49 {
  50         CPT2_NONE,
  51         // Need 8-bit param2
  52         CPT2_FULL,
  53         // Flowing liquid properties
  54         CPT2_FLOWINGLIQUID,
  55         // Direction for chests and furnaces and such
  56         CPT2_FACEDIR,
  57         // Direction for signs, torches and such
  58         CPT2_WALLMOUNTED,
  59 };
  60
  61 enum LiquidType
  62 {
  63         LIQUID_NONE,
  64         LIQUID_FLOWING,
  65         LIQUID_SOURCE
  66 };
  67
  68 enum NodeBoxType
  69 {
  70         NODEBOX_REGULAR, // Regular block; allows buildable_to
  71         NODEBOX_FIXED, // Static separately defined box(es)
  72         NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
  73 };
  74
  75 struct NodeBox
  76 {
  77         enum NodeBoxType type;
  78         // NODEBOX_REGULAR (no parameters)
  79         // NODEBOX_FIXED
  80         std::vector<aabb3f> fixed;
  81         // NODEBOX_WALLMOUNTED
  82         aabb3f wall_top;
  83         aabb3f wall_bottom;
  84         aabb3f wall_side; // being at the -X side
  85
  86         NodeBox()
  87         { reset(); }
  88
  89         void reset();
  90         void serialize(std::ostream &os) const;
  91         void deSerialize(std::istream &is);
  92 };
  93
  94 struct MapNode;
  95 class NodeMetadata;
  96
  97 /*
  98         Stand-alone definition of a TileSpec (basically a server-side TileSpec)
  99 */
 100 enum TileAnimationType{
 101         TAT_NONE=0,
 102         TAT_VERTICAL_FRAMES=1,
 103 };
 104 struct TileDef
 105 {
 106         std::string name;
 107         bool backface_culling; // Takes effect only in special cases
 108         struct{
 109                 enum TileAnimationType type;
 110                 int aspect_w; // width for aspect ratio
 111                 int aspect_h; // height for aspect ratio
 112                 float length; // seconds
 113         } animation;
 114
 115         TileDef()
 116         {
 117                 name = "";
 118                 backface_culling = true;
 119                 animation.type = TAT_NONE;
 120                 animation.aspect_w = 1;
 121                 animation.aspect_h = 1;
 122                 animation.length = 1.0;
 123         }
 124
 125         void serialize(std::ostream &os, u16 protocol_version) const;
 126         void deSerialize(std::istream &is);
 127 };
 128
 129 enum NodeDrawType
 130 {
 131         NDT_NORMAL, // A basic solid block
 132         NDT_AIRLIKE, // Nothing is drawn
 133         NDT_LIQUID, // Do not draw face towards same kind of flowing/source liquid
 134         NDT_FLOWINGLIQUID, // A very special kind of thing
 135         NDT_GLASSLIKE, // Glass-like, don't draw faces towards other glass
 136         NDT_ALLFACES, // Leaves-like, draw all faces no matter what
 137         NDT_ALLFACES_OPTIONAL, // Fancy -> allfaces, fast -> normal
 138         NDT_TORCHLIKE,
 139         NDT_SIGNLIKE,
 140         NDT_PLANTLIKE,
 141         NDT_FENCELIKE,
 142         NDT_RAILLIKE,
 143         NDT_NODEBOX,
 144 };
 145
 146 #define CF_SPECIAL_COUNT 2
 147
 148 struct ContentFeatures
 149 {
 150         /*
 151                 Cached stuff
 152         */
 153 #ifndef SERVER
 154         // 0     1     2     3     4     5
 155         // up    down  right left  back  front
 156         TileSpec tiles[6];
 157         // Special tiles
 158         // - Currently used for flowing liquids
 159         TileSpec special_tiles[CF_SPECIAL_COUNT];
 160         u8 solidness; // Used when choosing which face is drawn
 161         u8 visual_solidness; // When solidness=0, this tells how it looks like
 162         bool backface_culling;
 163 #endif
 164
 165         // Server-side cached callback existence for fast skipping
 166         bool has_on_construct;
 167         bool has_on_destruct;
 168         bool has_after_destruct;
 169
 170         /*
 171                 Actual data
 172         */
 173
 174         std::string name; // "" = undefined node
 175         ItemGroupList groups; // Same as in itemdef
 176
 177         // Visual definition
 178         enum NodeDrawType drawtype;
 179         float visual_scale; // Misc. scale parameter
 180         TileDef tiledef[6];
 181         TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
 182         u8 alpha;
 183
 184         // Post effect color, drawn when the camera is inside the node.
 185         video::SColor post_effect_color;
 186         // Type of MapNode::param1
 187         ContentParamType param_type;
 188         // Type of MapNode::param2
 189         ContentParamType2 param_type_2;
 190         // True for all ground-like things like stone and mud, false for eg. trees
 191         bool is_ground_content;
 192         bool light_propagates;
 193         bool sunlight_propagates;
 194         // This is used for collision detection.
 195         // Also for general solidness queries.
 196         bool walkable;
 197         // Player can point to these
 198         bool pointable;
 199         // Player can dig these
 200         bool diggable;
 201         // Player can climb these
 202         bool climbable;
 203         // Player can build on these
 204         bool buildable_to;
 205         // Player cannot build to these (placement prediction disabled)
 206         bool rightclickable;
 207         // Whether the node is non-liquid, source liquid or flowing liquid
 208         enum LiquidType liquid_type;
 209         // If the content is liquid, this is the flowing version of the liquid.
 210         std::string liquid_alternative_flowing;
 211         // If the content is liquid, this is the source version of the liquid.
 212         std::string liquid_alternative_source;
 213         // Viscosity for fluid flow, ranging from 1 to 7, with
 214         // 1 giving almost instantaneous propagation and 7 being
 215         // the slowest possible
 216         u8 liquid_viscosity;
 217         // Is liquid renewable (new liquid source will be created between 2 existing)
 218         bool liquid_renewable;
 219         // Amount of light the node emits
 220         u8 light_source;
 221         u32 damage_per_second;
 222         NodeBox node_box;
 223         NodeBox selection_box;
 224         // Compatibility with old maps
 225         // Set to true if paramtype used to be 'facedir_simple'
 226         bool legacy_facedir_simple;
 227         // Set to true if wall_mounted used to be set to true
 228         bool legacy_wallmounted;
 229
 230         // Sound properties
 231         SimpleSoundSpec sound_footstep;
 232         SimpleSoundSpec sound_dig;
 233         SimpleSoundSpec sound_dug;
 234
 235         /*
 236                 Methods
 237         */
 238
 239         ContentFeatures();
 240         ~ContentFeatures();
 241         void reset();
 242         void serialize(std::ostream &os, u16 protocol_version);
 243         void deSerialize(std::istream &is);
 244         void serializeOld(std::ostream &os, u16 protocol_version);
 245         void deSerializeOld(std::istream &is, int version);
 246
 247         /*
 248                 Some handy methods
 249         */
 250         bool isLiquid() const{
 251                 return (liquid_type != LIQUID_NONE);
 252         }
 253         bool sameLiquid(const ContentFeatures &f) const{
 254                 if(!isLiquid() || !f.isLiquid()) return false;
 255                 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
 256         }
 257 };
 258
 259 class INodeDefManager
 260 {
 261 public:
 262         INodeDefManager(){}
 263         virtual ~INodeDefManager(){}
 264         // Get node definition
 265         virtual const ContentFeatures& get(content_t c) const=0;
 266         virtual const ContentFeatures& get(const MapNode &n) const=0;
 267         virtual bool getId(const std::string &name, content_t &result) const=0;
 268         virtual content_t getId(const std::string &name) const=0;
 269         // Allows "group:name" in addition to regular node names
 270         virtual void getIds(const std::string &name, std::set<content_t> &result)
 271                         const=0;
 272         virtual const ContentFeatures& get(const std::string &name) const=0;
 273
 274         virtual void serialize(std::ostream &os, u16 protocol_version)=0;
 275 };
 276
 277 class IWritableNodeDefManager : public INodeDefManager
 278 {
 279 public:
 280         IWritableNodeDefManager(){}
 281         virtual ~IWritableNodeDefManager(){}
 282         virtual IWritableNodeDefManager* clone()=0;
 283         // Get node definition
 284         virtual const ContentFeatures& get(content_t c) const=0;
 285         virtual const ContentFeatures& get(const MapNode &n) const=0;
 286         virtual bool getId(const std::string &name, content_t &result) const=0;
 287         virtual content_t getId(const std::string &name) const=0;
 288         // Allows "group:name" in addition to regular node names
 289         virtual void getIds(const std::string &name, std::set<content_t> &result)
 290                         const=0;
 291         // If not found, returns the features of CONTENT_IGNORE
 292         virtual const ContentFeatures& get(const std::string &name) const=0;
 293
 294         // Register node definition
 295         virtual void set(content_t c, const ContentFeatures &def)=0;
 296         // Register node definition by name (allocate an id)
 297         // If returns CONTENT_IGNORE, could not allocate id
 298         virtual content_t set(const std::string &name,
 299                         const ContentFeatures &def)=0;
 300         // If returns CONTENT_IGNORE, could not allocate id
 301         virtual content_t allocateDummy(const std::string &name)=0;
 302
 303         /*
 304                 Update item alias mapping.
 305                 Call after updating item definitions.
 306         */
 307         virtual void updateAliases(IItemDefManager *idef)=0;
 308
 309         /*
 310                 Update tile textures to latest return values of TextueSource.
 311                 Call after updating the texture atlas of a TextureSource.
 312         */
 313         virtual void updateTextures(ITextureSource *tsrc)=0;
 314
 315         virtual void serialize(std::ostream &os, u16 protocol_version)=0;
 316         virtual void deSerialize(std::istream &is)=0;
 317 };
 318
 319 IWritableNodeDefManager* createNodeDefManager();
 320
 321 #endif
 322