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 "util/numeric.h"
  29 #include "mapnode.h"
  30 #ifndef SERVER
  31 #include "client/tile.h"
  32 #include "shader.h"
  33 #include <IMeshManipulator.h>
  34 class Client;
  35 #endif
  36 #include "itemgroup.h"
  37 #include "sound.h" // SimpleSoundSpec
  38 #include "constants.h" // BS
  39 #include "tileanimation.h"
  40
  41 class INodeDefManager;
  42 class IItemDefManager;
  43 class ITextureSource;
  44 class IShaderSource;
  45 class IGameDef;
  46 class NodeResolver;
  47
  48 typedef std::list<std::pair<content_t, int> > GroupItems;
  49
  50 enum ContentParamType
  51 {
  52         CPT_NONE,
  53         CPT_LIGHT,
  54 };
  55
  56 enum ContentParamType2
  57 {
  58         CPT2_NONE,
  59         // Need 8-bit param2
  60         CPT2_FULL,
  61         // Flowing liquid properties
  62         CPT2_FLOWINGLIQUID,
  63         // Direction for chests and furnaces and such
  64         CPT2_FACEDIR,
  65         // Direction for signs, torches and such
  66         CPT2_WALLMOUNTED,
  67         // Block level like FLOWINGLIQUID
  68         CPT2_LEVELED,
  69         // 2D rotation for things like plants
  70         CPT2_DEGROTATE,
  71         // Mesh options for plants
  72         CPT2_MESHOPTIONS,
  73         // Index for palette
  74         CPT2_COLOR,
  75         // 3 bits of palette index, then facedir
  76         CPT2_COLORED_FACEDIR,
  77         // 5 bits of palette index, then wallmounted
  78         CPT2_COLORED_WALLMOUNTED,
  79         // Glasslike framed drawtype internal liquid level, param2 values 0 to 63
  80         CPT2_GLASSLIKE_LIQUID_LEVEL,
  81 };
  82
  83 enum LiquidType
  84 {
  85         LIQUID_NONE,
  86         LIQUID_FLOWING,
  87         LIQUID_SOURCE,
  88 };
  89
  90 enum NodeBoxType
  91 {
  92         NODEBOX_REGULAR, // Regular block; allows buildable_to
  93         NODEBOX_FIXED, // Static separately defined box(es)
  94         NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
  95         NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
  96         NODEBOX_CONNECTED, // optionally draws nodeboxes if a neighbor node attaches
  97 };
  98
  99 struct NodeBox
 100 {
 101         enum NodeBoxType type;
 102         // NODEBOX_REGULAR (no parameters)
 103         // NODEBOX_FIXED
 104         std::vector<aabb3f> fixed;
 105         // NODEBOX_WALLMOUNTED
 106         aabb3f wall_top;
 107         aabb3f wall_bottom;
 108         aabb3f wall_side; // being at the -X side
 109         // NODEBOX_CONNECTED
 110         std::vector<aabb3f> connect_top;
 111         std::vector<aabb3f> connect_bottom;
 112         std::vector<aabb3f> connect_front;
 113         std::vector<aabb3f> connect_left;
 114         std::vector<aabb3f> connect_back;
 115         std::vector<aabb3f> connect_right;
 116
 117         NodeBox()
 118         { reset(); }
 119
 120         void reset();
 121         void serialize(std::ostream &os, u16 protocol_version) const;
 122         void deSerialize(std::istream &is);
 123 };
 124
 125 struct MapNode;
 126 class NodeMetadata;
 127
 128 enum LeavesStyle {
 129         LEAVES_FANCY,
 130         LEAVES_SIMPLE,
 131         LEAVES_OPAQUE,
 132 };
 133
 134 class TextureSettings {
 135 public:
 136         LeavesStyle leaves_style;
 137         bool opaque_water;
 138         bool connected_glass;
 139         bool use_normal_texture;
 140         bool enable_mesh_cache;
 141         bool enable_minimap;
 142
 143         TextureSettings() {}
 144
 145         void readSettings();
 146 };
 147
 148 enum NodeDrawType
 149 {
 150         // A basic solid block
 151         NDT_NORMAL,
 152         // Nothing is drawn
 153         NDT_AIRLIKE,
 154         // Do not draw face towards same kind of flowing/source liquid
 155         NDT_LIQUID,
 156         // A very special kind of thing
 157         NDT_FLOWINGLIQUID,
 158         // Glass-like, don't draw faces towards other glass
 159         NDT_GLASSLIKE,
 160         // Leaves-like, draw all faces no matter what
 161         NDT_ALLFACES,
 162         // Enabled -> ndt_allfaces, disabled -> ndt_normal
 163         NDT_ALLFACES_OPTIONAL,
 164         // Single plane perpendicular to a surface
 165         NDT_TORCHLIKE,
 166         // Single plane parallel to a surface
 167         NDT_SIGNLIKE,
 168         // 2 vertical planes in a 'X' shape diagonal to XZ axes.
 169         // paramtype2 = "meshoptions" allows various forms, sizes and
 170         // vertical and horizontal random offsets.
 171         NDT_PLANTLIKE,
 172         // Fenceposts that connect to neighbouring fenceposts with horizontal bars
 173         NDT_FENCELIKE,
 174         // Selects appropriate junction texture to connect like rails to
 175         // neighbouring raillikes.
 176         NDT_RAILLIKE,
 177         // Custom Lua-definable structure of multiple cuboids
 178         NDT_NODEBOX,
 179         // Glass-like, draw connected frames and all visible faces.
 180         // param2 > 0 defines 64 levels of internal liquid
 181         // Uses 3 textures, one for frames, second for faces,
 182         // optional third is a 'special tile' for the liquid.
 183         NDT_GLASSLIKE_FRAMED,
 184         // Draw faces slightly rotated and only on neighbouring nodes
 185         NDT_FIRELIKE,
 186         // Enabled -> ndt_glasslike_framed, disabled -> ndt_glasslike
 187         NDT_GLASSLIKE_FRAMED_OPTIONAL,
 188         // Uses static meshes
 189         NDT_MESH,
 190 };
 191
 192 // Mesh options for NDT_PLANTLIKE with CPT2_MESHOPTIONS
 193 static const u8 MO_MASK_STYLE          = 0x07;
 194 static const u8 MO_BIT_RANDOM_OFFSET   = 0x08;
 195 static const u8 MO_BIT_SCALE_SQRT2     = 0x10;
 196 static const u8 MO_BIT_RANDOM_OFFSET_Y = 0x20;
 197 enum PlantlikeStyle {
 198         PLANT_STYLE_CROSS,
 199         PLANT_STYLE_CROSS2,
 200         PLANT_STYLE_STAR,
 201         PLANT_STYLE_HASH,
 202         PLANT_STYLE_HASH2,
 203 };
 204
 205 /*
 206         Stand-alone definition of a TileSpec (basically a server-side TileSpec)
 207 */
 208
 209 struct TileDef
 210 {
 211         std::string name = "";
 212         bool backface_culling = true; // Takes effect only in special cases
 213         bool tileable_horizontal = true;
 214         bool tileable_vertical = true;
 215         //! If true, the tile has its own color.
 216         bool has_color = false;
 217         //! The color of the tile.
 218         video::SColor color = video::SColor(0xFFFFFFFF);
 219
 220         struct TileAnimationParams animation;
 221
 222         TileDef()
 223         {
 224                 animation.type = TAT_NONE;
 225         }
 226
 227         void serialize(std::ostream &os, u16 protocol_version) const;
 228         void deSerialize(std::istream &is, const u8 contentfeatures_version, const NodeDrawType drawtype);
 229 };
 230
 231 #define CF_SPECIAL_COUNT 6
 232
 233 struct ContentFeatures
 234 {
 235         /*
 236                 Cached stuff
 237          */
 238 #ifndef SERVER
 239         // 0     1     2     3     4     5
 240         // up    down  right left  back  front
 241         TileSpec tiles[6];
 242         // Special tiles
 243         // - Currently used for flowing liquids
 244         TileSpec special_tiles[CF_SPECIAL_COUNT];
 245         u8 solidness; // Used when choosing which face is drawn
 246         u8 visual_solidness; // When solidness=0, this tells how it looks like
 247         bool backface_culling;
 248 #endif
 249
 250         // Server-side cached callback existence for fast skipping
 251         bool has_on_construct;
 252         bool has_on_destruct;
 253         bool has_after_destruct;
 254
 255         /*
 256                 Actual data
 257          */
 258
 259         // --- GENERAL PROPERTIES ---
 260
 261         std::string name; // "" = undefined node
 262         ItemGroupList groups; // Same as in itemdef
 263         // Type of MapNode::param1
 264         ContentParamType param_type;
 265         // Type of MapNode::param2
 266         ContentParamType2 param_type_2;
 267
 268         // --- VISUAL PROPERTIES ---
 269
 270         enum NodeDrawType drawtype;
 271         std::string mesh;
 272 #ifndef SERVER
 273         scene::IMesh *mesh_ptr[24];
 274         video::SColor minimap_color;
 275 #endif
 276         float visual_scale; // Misc. scale parameter
 277         TileDef tiledef[6];
 278         // These will be drawn over the base tiles.
 279         TileDef tiledef_overlay[6];
 280         TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
 281         // If 255, the node is opaque.
 282         // Otherwise it uses texture alpha.
 283         u8 alpha;
 284         // The color of the node.
 285         video::SColor color;
 286         std::string palette_name;
 287         std::vector<video::SColor> *palette;
 288         // Used for waving leaves/plants
 289         u8 waving;
 290         // for NDT_CONNECTED pairing
 291         u8 connect_sides;
 292         std::vector<std::string> connects_to;
 293         std::set<content_t> connects_to_ids;
 294         // Post effect color, drawn when the camera is inside the node.
 295         video::SColor post_effect_color;
 296         // Flowing liquid or snow, value = default level
 297         u8 leveled;
 298
 299         // --- LIGHTING-RELATED ---
 300
 301         bool light_propagates;
 302         bool sunlight_propagates;
 303         // Amount of light the node emits
 304         u8 light_source;
 305
 306         // --- MAP GENERATION ---
 307
 308         // True for all ground-like things like stone and mud, false for eg. trees
 309         bool is_ground_content;
 310
 311         // --- INTERACTION PROPERTIES ---
 312
 313         // This is used for collision detection.
 314         // Also for general solidness queries.
 315         bool walkable;
 316         // Player can point to these
 317         bool pointable;
 318         // Player can dig these
 319         bool diggable;
 320         // Player can climb these
 321         bool climbable;
 322         // Player can build on these
 323         bool buildable_to;
 324         // Player cannot build to these (placement prediction disabled)
 325         bool rightclickable;
 326         u32 damage_per_second;
 327
 328         // --- LIQUID PROPERTIES ---
 329
 330         // Whether the node is non-liquid, source liquid or flowing liquid
 331         enum LiquidType liquid_type;
 332         // If the content is liquid, this is the flowing version of the liquid.
 333         std::string liquid_alternative_flowing;
 334         // If the content is liquid, this is the source version of the liquid.
 335         std::string liquid_alternative_source;
 336         // Viscosity for fluid flow, ranging from 1 to 7, with
 337         // 1 giving almost instantaneous propagation and 7 being
 338         // the slowest possible
 339         u8 liquid_viscosity;
 340         // Is liquid renewable (new liquid source will be created between 2 existing)
 341         bool liquid_renewable;
 342         // Number of flowing liquids surrounding source
 343         u8 liquid_range;
 344         u8 drowning;
 345         // Liquids flow into and replace node
 346         bool floodable;
 347
 348         // --- NODEBOXES ---
 349
 350         NodeBox node_box;
 351         NodeBox selection_box;
 352         NodeBox collision_box;
 353
 354         // --- SOUND PROPERTIES ---
 355
 356         SimpleSoundSpec sound_footstep;
 357         SimpleSoundSpec sound_dig;
 358         SimpleSoundSpec sound_dug;
 359
 360         // --- LEGACY ---
 361
 362         // Compatibility with old maps
 363         // Set to true if paramtype used to be 'facedir_simple'
 364         bool legacy_facedir_simple;
 365         // Set to true if wall_mounted used to be set to true
 366         bool legacy_wallmounted;
 367
 368         /*
 369                 Methods
 370         */
 371
 372         ContentFeatures();
 373         ~ContentFeatures();
 374         void reset();
 375         void serialize(std::ostream &os, u16 protocol_version) const;
 376         void deSerialize(std::istream &is);
 377         void serializeOld(std::ostream &os, u16 protocol_version) const;
 378         void deSerializeOld(std::istream &is, int version);
 379         /*!
 380          * Since vertex alpha is no longer supported, this method
 381          * adds opacity directly to the texture pixels.
 382          *
 383          * \param tiles array of the tile definitions.
 384          * \param length length of tiles
 385          */
 386         void correctAlpha(TileDef *tiles, int length);
 387
 388         /*
 389                 Some handy methods
 390         */
 391         bool isLiquid() const{
 392                 return (liquid_type != LIQUID_NONE);
 393         }
 394         bool sameLiquid(const ContentFeatures &f) const{
 395                 if(!isLiquid() || !f.isLiquid()) return false;
 396                 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
 397         }
 398
 399         int getGroup(const std::string &group) const
 400         {
 401                 return itemgroup_get(groups, group);
 402         }
 403
 404 #ifndef SERVER
 405         void fillTileAttribs(ITextureSource *tsrc, TileLayer *tile, TileDef *tiledef,
 406                 u32 shader_id, bool use_normal_texture, bool backface_culling,
 407                 u8 material_type);
 408         void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
 409                 scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
 410 #endif
 411 };
 412
 413 class INodeDefManager {
 414 public:
 415         INodeDefManager(){}
 416         virtual ~INodeDefManager(){}
 417         // Get node definition
 418         virtual const ContentFeatures &get(content_t c) const=0;
 419         virtual const ContentFeatures &get(const MapNode &n) const=0;
 420         virtual bool getId(const std::string &name, content_t &result) const=0;
 421         virtual content_t getId(const std::string &name) const=0;
 422         // Allows "group:name" in addition to regular node names
 423         // returns false if node name not found, true otherwise
 424         virtual bool getIds(const std::string &name, std::set<content_t> &result)
 425                         const=0;
 426         virtual const ContentFeatures &get(const std::string &name) const=0;
 427
 428         virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
 429
 430         virtual void pendNodeResolve(NodeResolver *nr)=0;
 431         virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
 432         virtual bool nodeboxConnects(const MapNode from, const MapNode to, u8 connect_face)=0;
 433         /*!
 434          * Returns the smallest box in node coordinates that
 435          * contains all nodes' selection boxes.
 436          */
 437         virtual core::aabbox3d<s16> getSelectionBoxIntUnion() const=0;
 438 };
 439
 440 class IWritableNodeDefManager : public INodeDefManager {
 441 public:
 442         IWritableNodeDefManager(){}
 443         virtual ~IWritableNodeDefManager(){}
 444         virtual IWritableNodeDefManager* clone()=0;
 445         // Get node definition
 446         virtual const ContentFeatures &get(content_t c) const=0;
 447         virtual const ContentFeatures &get(const MapNode &n) const=0;
 448         virtual bool getId(const std::string &name, content_t &result) const=0;
 449         // If not found, returns CONTENT_IGNORE
 450         virtual content_t getId(const std::string &name) const=0;
 451         // Allows "group:name" in addition to regular node names
 452         virtual bool getIds(const std::string &name, std::set<content_t> &result)
 453                 const=0;
 454         // If not found, returns the features of CONTENT_UNKNOWN
 455         virtual const ContentFeatures &get(const std::string &name) const=0;
 456
 457         // Register node definition by name (allocate an id)
 458         // If returns CONTENT_IGNORE, could not allocate id
 459         virtual content_t set(const std::string &name,
 460                         const ContentFeatures &def)=0;
 461         // If returns CONTENT_IGNORE, could not allocate id
 462         virtual content_t allocateDummy(const std::string &name)=0;
 463         // Remove a node
 464         virtual void removeNode(const std::string &name)=0;
 465
 466         /*
 467                 Update item alias mapping.
 468                 Call after updating item definitions.
 469         */
 470         virtual void updateAliases(IItemDefManager *idef)=0;
 471
 472         /*
 473                 Override textures from servers with ones specified in texturepack/override.txt
 474         */
 475         virtual void applyTextureOverrides(const std::string &override_filepath)=0;
 476
 477         /*
 478                 Update tile textures to latest return values of TextueSource.
 479         */
 480         virtual void updateTextures(IGameDef *gamedef,
 481                 void (*progress_cbk)(void *progress_args, u32 progress, u32 max_progress),
 482                 void *progress_cbk_args)=0;
 483
 484         virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
 485         virtual void deSerialize(std::istream &is)=0;
 486
 487         virtual void setNodeRegistrationStatus(bool completed)=0;
 488
 489         virtual void pendNodeResolve(NodeResolver *nr)=0;
 490         virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
 491         virtual void runNodeResolveCallbacks()=0;
 492         virtual void resetNodeResolveState()=0;
 493         virtual void mapNodeboxConnections()=0;
 494         virtual core::aabbox3d<s16> getSelectionBoxIntUnion() const=0;
 495 };
 496
 497 IWritableNodeDefManager *createNodeDefManager();
 498
 499 class NodeResolver {
 500 public:
 501         NodeResolver();
 502         virtual ~NodeResolver();
 503         virtual void resolveNodeNames() = 0;
 504
 505         bool getIdFromNrBacklog(content_t *result_out,
 506                 const std::string &node_alt, content_t c_fallback);
 507         bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
 508                 bool all_required=false, content_t c_fallback=CONTENT_IGNORE);
 509
 510         void nodeResolveInternal();
 511
 512         u32 m_nodenames_idx = 0;
 513         u32 m_nnlistsizes_idx = 0;
 514         std::vector<std::string> m_nodenames;
 515         std::vector<size_t> m_nnlistsizes;
 516         INodeDefManager *m_ndef = nullptr;
 517         bool m_resolve_done = false;
 518 };
 519
 520 #endif