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 #pragma once
  21
  22 #include "irrlichttypes_bloated.h"
  23 #include <string>
  24 #include <iostream>
  25 #include <map>
  26 #include "mapnode.h"
  27 #include "nameidmapping.h"
  28 #ifndef SERVER
  29 #include "client/tile.h"
  30 #include <IMeshManipulator.h>
  31 class Client;
  32 #endif
  33 #include "itemgroup.h"
  34 #include "sound.h" // SimpleSoundSpec
  35 #include "constants.h" // BS
  36 #include "texture_override.h" // TextureOverride
  37 #include "tileanimation.h"
  38
  39 // PROTOCOL_VERSION >= 37
  40 static const u8 CONTENTFEATURES_VERSION = 13;
  41
  42 class IItemDefManager;
  43 class ITextureSource;
  44 class IShaderSource;
  45 class IGameDef;
  46 class NodeResolver;
  47
  48 enum ContentParamType
  49 {
  50         CPT_NONE,
  51         CPT_LIGHT,
  52 };
  53
  54 enum ContentParamType2
  55 {
  56         CPT2_NONE,
  57         // Need 8-bit param2
  58         CPT2_FULL,
  59         // Flowing liquid properties
  60         CPT2_FLOWINGLIQUID,
  61         // Direction for chests and furnaces and such
  62         CPT2_FACEDIR,
  63         // Direction for signs, torches and such
  64         CPT2_WALLMOUNTED,
  65         // Block level like FLOWINGLIQUID
  66         CPT2_LEVELED,
  67         // 2D rotation for things like plants
  68         CPT2_DEGROTATE,
  69         // Mesh options for plants
  70         CPT2_MESHOPTIONS,
  71         // Index for palette
  72         CPT2_COLOR,
  73         // 3 bits of palette index, then facedir
  74         CPT2_COLORED_FACEDIR,
  75         // 5 bits of palette index, then wallmounted
  76         CPT2_COLORED_WALLMOUNTED,
  77         // Glasslike framed drawtype internal liquid level, param2 values 0 to 63
  78         CPT2_GLASSLIKE_LIQUID_LEVEL,
  79 };
  80
  81 enum LiquidType
  82 {
  83         LIQUID_NONE,
  84         LIQUID_FLOWING,
  85         LIQUID_SOURCE,
  86 };
  87
  88 enum NodeBoxType
  89 {
  90         NODEBOX_REGULAR, // Regular block; allows buildable_to
  91         NODEBOX_FIXED, // Static separately defined box(es)
  92         NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
  93         NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
  94         NODEBOX_CONNECTED, // optionally draws nodeboxes if a neighbor node attaches
  95 };
  96
  97 struct NodeBox
  98 {
  99         enum NodeBoxType type;
 100         // NODEBOX_REGULAR (no parameters)
 101         // NODEBOX_FIXED
 102         std::vector<aabb3f> fixed;
 103         // NODEBOX_WALLMOUNTED
 104         aabb3f wall_top;
 105         aabb3f wall_bottom;
 106         aabb3f wall_side; // being at the -X side
 107         // NODEBOX_CONNECTED
 108         std::vector<aabb3f> connect_top;
 109         std::vector<aabb3f> connect_bottom;
 110         std::vector<aabb3f> connect_front;
 111         std::vector<aabb3f> connect_left;
 112         std::vector<aabb3f> connect_back;
 113         std::vector<aabb3f> connect_right;
 114         std::vector<aabb3f> disconnected_top;
 115         std::vector<aabb3f> disconnected_bottom;
 116         std::vector<aabb3f> disconnected_front;
 117         std::vector<aabb3f> disconnected_left;
 118         std::vector<aabb3f> disconnected_back;
 119         std::vector<aabb3f> disconnected_right;
 120         std::vector<aabb3f> disconnected;
 121         std::vector<aabb3f> disconnected_sides;
 122
 123         NodeBox()
 124         { reset(); }
 125
 126         void reset();
 127         void serialize(std::ostream &os, u16 protocol_version) const;
 128         void deSerialize(std::istream &is);
 129 };
 130
 131 struct MapNode;
 132 class NodeMetadata;
 133
 134 enum LeavesStyle {
 135         LEAVES_FANCY,
 136         LEAVES_SIMPLE,
 137         LEAVES_OPAQUE,
 138 };
 139
 140 enum AutoScale : u8 {
 141         AUTOSCALE_DISABLE,
 142         AUTOSCALE_ENABLE,
 143         AUTOSCALE_FORCE,
 144 };
 145
 146 enum WorldAlignMode : u8 {
 147         WORLDALIGN_DISABLE,
 148         WORLDALIGN_ENABLE,
 149         WORLDALIGN_FORCE,
 150         WORLDALIGN_FORCE_NODEBOX,
 151 };
 152
 153 class TextureSettings {
 154 public:
 155         LeavesStyle leaves_style;
 156         WorldAlignMode world_aligned_mode;
 157         AutoScale autoscale_mode;
 158         int node_texture_size;
 159         bool opaque_water;
 160         bool connected_glass;
 161         bool use_normal_texture;
 162         bool enable_mesh_cache;
 163         bool enable_minimap;
 164
 165         TextureSettings() = default;
 166
 167         void readSettings();
 168 };
 169
 170 enum NodeDrawType
 171 {
 172         // A basic solid block
 173         NDT_NORMAL,
 174         // Nothing is drawn
 175         NDT_AIRLIKE,
 176         // Do not draw face towards same kind of flowing/source liquid
 177         NDT_LIQUID,
 178         // A very special kind of thing
 179         NDT_FLOWINGLIQUID,
 180         // Glass-like, don't draw faces towards other glass
 181         NDT_GLASSLIKE,
 182         // Leaves-like, draw all faces no matter what
 183         NDT_ALLFACES,
 184         // Enabled -> ndt_allfaces, disabled -> ndt_normal
 185         NDT_ALLFACES_OPTIONAL,
 186         // Single plane perpendicular to a surface
 187         NDT_TORCHLIKE,
 188         // Single plane parallel to a surface
 189         NDT_SIGNLIKE,
 190         // 2 vertical planes in a 'X' shape diagonal to XZ axes.
 191         // paramtype2 = "meshoptions" allows various forms, sizes and
 192         // vertical and horizontal random offsets.
 193         NDT_PLANTLIKE,
 194         // Fenceposts that connect to neighbouring fenceposts with horizontal bars
 195         NDT_FENCELIKE,
 196         // Selects appropriate junction texture to connect like rails to
 197         // neighbouring raillikes.
 198         NDT_RAILLIKE,
 199         // Custom Lua-definable structure of multiple cuboids
 200         NDT_NODEBOX,
 201         // Glass-like, draw connected frames and all visible faces.
 202         // param2 > 0 defines 64 levels of internal liquid
 203         // Uses 3 textures, one for frames, second for faces,
 204         // optional third is a 'special tile' for the liquid.
 205         NDT_GLASSLIKE_FRAMED,
 206         // Draw faces slightly rotated and only on neighbouring nodes
 207         NDT_FIRELIKE,
 208         // Enabled -> ndt_glasslike_framed, disabled -> ndt_glasslike
 209         NDT_GLASSLIKE_FRAMED_OPTIONAL,
 210         // Uses static meshes
 211         NDT_MESH,
 212         // Combined plantlike-on-solid
 213         NDT_PLANTLIKE_ROOTED,
 214 };
 215
 216 // Mesh options for NDT_PLANTLIKE with CPT2_MESHOPTIONS
 217 static const u8 MO_MASK_STYLE          = 0x07;
 218 static const u8 MO_BIT_RANDOM_OFFSET   = 0x08;
 219 static const u8 MO_BIT_SCALE_SQRT2     = 0x10;
 220 static const u8 MO_BIT_RANDOM_OFFSET_Y = 0x20;
 221 enum PlantlikeStyle {
 222         PLANT_STYLE_CROSS,
 223         PLANT_STYLE_CROSS2,
 224         PLANT_STYLE_STAR,
 225         PLANT_STYLE_HASH,
 226         PLANT_STYLE_HASH2,
 227 };
 228
 229 enum AlignStyle : u8 {
 230         ALIGN_STYLE_NODE,
 231         ALIGN_STYLE_WORLD,
 232         ALIGN_STYLE_USER_DEFINED,
 233 };
 234
 235 /*
 236         Stand-alone definition of a TileSpec (basically a server-side TileSpec)
 237 */
 238
 239 struct TileDef
 240 {
 241         std::string name = "";
 242         bool backface_culling = true; // Takes effect only in special cases
 243         bool tileable_horizontal = true;
 244         bool tileable_vertical = true;
 245         //! If true, the tile has its own color.
 246         bool has_color = false;
 247         //! The color of the tile.
 248         video::SColor color = video::SColor(0xFFFFFFFF);
 249         AlignStyle align_style = ALIGN_STYLE_NODE;
 250         u8 scale = 0;
 251
 252         struct TileAnimationParams animation;
 253
 254         TileDef()
 255         {
 256                 animation.type = TAT_NONE;
 257         }
 258
 259         void serialize(std::ostream &os, u16 protocol_version) const;
 260         void deSerialize(std::istream &is, u8 contentfeatures_version,
 261                 NodeDrawType drawtype);
 262 };
 263
 264 // Defines the number of special tiles per nodedef
 265 //
 266 // NOTE: When changing this value, the enum entries of OverrideTarget and
 267 //       parser in TextureOverrideSource must be updated so that all special
 268 //       tiles can be overridden.
 269 #define CF_SPECIAL_COUNT 6
 270
 271 struct ContentFeatures
 272 {
 273         /*
 274                 Cached stuff
 275          */
 276 #ifndef SERVER
 277         // 0     1     2     3     4     5
 278         // up    down  right left  back  front
 279         TileSpec tiles[6];
 280         // Special tiles
 281         // - Currently used for flowing liquids
 282         TileSpec special_tiles[CF_SPECIAL_COUNT];
 283         u8 solidness; // Used when choosing which face is drawn
 284         u8 visual_solidness; // When solidness=0, this tells how it looks like
 285         bool backface_culling;
 286 #endif
 287
 288         // Server-side cached callback existence for fast skipping
 289         bool has_on_construct;
 290         bool has_on_destruct;
 291         bool has_after_destruct;
 292
 293         /*
 294                 Actual data
 295          */
 296
 297         // --- GENERAL PROPERTIES ---
 298
 299         std::string name; // "" = undefined node
 300         ItemGroupList groups; // Same as in itemdef
 301         // Type of MapNode::param1
 302         ContentParamType param_type;
 303         // Type of MapNode::param2
 304         ContentParamType2 param_type_2;
 305
 306         // --- VISUAL PROPERTIES ---
 307
 308         enum NodeDrawType drawtype;
 309         std::string mesh;
 310 #ifndef SERVER
 311         scene::IMesh *mesh_ptr[24];
 312         video::SColor minimap_color;
 313 #endif
 314         float visual_scale; // Misc. scale parameter
 315         TileDef tiledef[6];
 316         // These will be drawn over the base tiles.
 317         TileDef tiledef_overlay[6];
 318         TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
 319         // If 255, the node is opaque.
 320         // Otherwise it uses texture alpha.
 321         u8 alpha;
 322         // The color of the node.
 323         video::SColor color;
 324         std::string palette_name;
 325         std::vector<video::SColor> *palette;
 326         // Used for waving leaves/plants
 327         u8 waving;
 328         // for NDT_CONNECTED pairing
 329         u8 connect_sides;
 330         std::vector<std::string> connects_to;
 331         std::vector<content_t> connects_to_ids;
 332         // Post effect color, drawn when the camera is inside the node.
 333         video::SColor post_effect_color;
 334         // Flowing liquid or leveled nodebox, value = default level
 335         u8 leveled;
 336         // Maximum value for leveled nodes
 337         u8 leveled_max;
 338
 339         // --- LIGHTING-RELATED ---
 340
 341         bool light_propagates;
 342         bool sunlight_propagates;
 343         // Amount of light the node emits
 344         u8 light_source;
 345
 346         // --- MAP GENERATION ---
 347
 348         // True for all ground-like things like stone and mud, false for eg. trees
 349         bool is_ground_content;
 350
 351         // --- INTERACTION PROPERTIES ---
 352
 353         // This is used for collision detection.
 354         // Also for general solidness queries.
 355         bool walkable;
 356         // Player can point to these
 357         bool pointable;
 358         // Player can dig these
 359         bool diggable;
 360         // Player can climb these
 361         bool climbable;
 362         // Player can build on these
 363         bool buildable_to;
 364         // Player cannot build to these (placement prediction disabled)
 365         bool rightclickable;
 366         u32 damage_per_second;
 367         // client dig prediction
 368         std::string node_dig_prediction;
 369
 370         // --- LIQUID PROPERTIES ---
 371
 372         // Whether the node is non-liquid, source liquid or flowing liquid
 373         enum LiquidType liquid_type;
 374         // If the content is liquid, this is the flowing version of the liquid.
 375         std::string liquid_alternative_flowing;
 376         content_t liquid_alternative_flowing_id;
 377         // If the content is liquid, this is the source version of the liquid.
 378         std::string liquid_alternative_source;
 379         content_t liquid_alternative_source_id;
 380         // Viscosity for fluid flow, ranging from 1 to 7, with
 381         // 1 giving almost instantaneous propagation and 7 being
 382         // the slowest possible
 383         u8 liquid_viscosity;
 384         // Is liquid renewable (new liquid source will be created between 2 existing)
 385         bool liquid_renewable;
 386         // Number of flowing liquids surrounding source
 387         u8 liquid_range;
 388         u8 drowning;
 389         // Liquids flow into and replace node
 390         bool floodable;
 391
 392         // --- NODEBOXES ---
 393
 394         NodeBox node_box;
 395         NodeBox selection_box;
 396         NodeBox collision_box;
 397
 398         // --- SOUND PROPERTIES ---
 399
 400         SimpleSoundSpec sound_footstep;
 401         SimpleSoundSpec sound_dig;
 402         SimpleSoundSpec sound_dug;
 403
 404         // --- LEGACY ---
 405
 406         // Compatibility with old maps
 407         // Set to true if paramtype used to be 'facedir_simple'
 408         bool legacy_facedir_simple;
 409         // Set to true if wall_mounted used to be set to true
 410         bool legacy_wallmounted;
 411
 412         /*
 413                 Methods
 414         */
 415
 416         ContentFeatures();
 417         ~ContentFeatures();
 418         void reset();
 419         void serialize(std::ostream &os, u16 protocol_version) const;
 420         void deSerialize(std::istream &is);
 421         /*!
 422          * Since vertex alpha is no longer supported, this method
 423          * adds opacity directly to the texture pixels.
 424          *
 425          * \param tiles array of the tile definitions.
 426          * \param length length of tiles
 427          */
 428         void correctAlpha(TileDef *tiles, int length);
 429
 430         /*
 431                 Some handy methods
 432         */
 433         bool needsBackfaceCulling() const
 434         {
 435                 switch (drawtype) {
 436                 case NDT_TORCHLIKE:
 437                 case NDT_SIGNLIKE:
 438                 case NDT_FIRELIKE:
 439                 case NDT_RAILLIKE:
 440                 case NDT_PLANTLIKE:
 441                 case NDT_PLANTLIKE_ROOTED:
 442                 case NDT_MESH:
 443                         return false;
 444                 default:
 445                         return true;
 446                 }
 447         }
 448
 449         bool isLiquid() const{
 450                 return (liquid_type != LIQUID_NONE);
 451         }
 452         bool sameLiquid(const ContentFeatures &f) const{
 453                 if(!isLiquid() || !f.isLiquid()) return false;
 454                 return (liquid_alternative_flowing_id == f.liquid_alternative_flowing_id);
 455         }
 456
 457         int getGroup(const std::string &group) const
 458         {
 459                 return itemgroup_get(groups, group);
 460         }
 461
 462 #ifndef SERVER
 463         void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
 464                 scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
 465 #endif
 466 };
 467
 468 /*!
 469  * @brief This class is for getting the actual properties of nodes from their
 470  * content ID.
 471  *
 472  * @details The nodes on the map are represented by three numbers (see MapNode).
 473  * The first number (param0) is the type of a node. All node types have own
 474  * properties (see ContentFeatures). This class is for storing and getting the
 475  * properties of nodes.
 476  * The manager is first filled with registered nodes, then as the game begins,
 477  * functions only get `const` pointers to it, to prevent modification of
 478  * registered nodes.
 479  */
 480 class NodeDefManager {
 481 public:
 482         /*!
 483          * Creates a NodeDefManager, and registers three ContentFeatures:
 484          * \ref CONTENT_AIR, \ref CONTENT_UNKNOWN and \ref CONTENT_IGNORE.
 485          */
 486         NodeDefManager();
 487         ~NodeDefManager();
 488
 489         /*!
 490          * Returns the properties for the given content type.
 491          * @param c content type of a node
 492          * @return properties of the given content type, or \ref CONTENT_UNKNOWN
 493          * if the given content type is not registered.
 494          */
 495         inline const ContentFeatures& get(content_t c) const {
 496                 return
 497                         c < m_content_features.size() ?
 498                                 m_content_features[c] : m_content_features[CONTENT_UNKNOWN];
 499         }
 500
 501         /*!
 502          * Returns the properties of the given node.
 503          * @param n a map node
 504          * @return properties of the given node or @ref CONTENT_UNKNOWN if the
 505          * given content type is not registered.
 506          */
 507         inline const ContentFeatures& get(const MapNode &n) const {
 508                 return get(n.getContent());
 509         }
 510
 511         /*!
 512          * Returns the node properties for a node name.
 513          * @param name name of a node
 514          * @return properties of the given node or @ref CONTENT_UNKNOWN if
 515          * not found
 516          */
 517         const ContentFeatures& get(const std::string &name) const;
 518
 519         /*!
 520          * Returns the content ID for the given name.
 521          * @param name a node name
 522          * @param[out] result will contain the content ID if found, otherwise
 523          * remains unchanged
 524          * @return true if the ID was found, false otherwise
 525          */
 526         bool getId(const std::string &name, content_t &result) const;
 527
 528         /*!
 529          * Returns the content ID for the given name.
 530          * @param name a node name
 531          * @return ID of the node or @ref CONTENT_IGNORE if not found
 532          */
 533         content_t getId(const std::string &name) const;
 534
 535         /*!
 536          * Returns the content IDs of the given node name or node group name.
 537          * Group names start with "group:".
 538          * @param name a node name or node group name
 539          * @param[out] result will be appended with matching IDs
 540          * @return true if `name` is a valid node name or a (not necessarily
 541          * valid) group name
 542          */
 543         bool getIds(const std::string &name, std::vector<content_t> &result) const;
 544
 545         /*!
 546          * Returns the smallest box in integer node coordinates that
 547          * contains all nodes' selection boxes. The returned box might be larger
 548          * than the minimal size if the largest node is removed from the manager.
 549          */
 550         inline core::aabbox3d<s16> getSelectionBoxIntUnion() const {
 551                 return m_selection_box_int_union;
 552         }
 553
 554         /*!
 555          * Checks whether a node connects to an adjacent node.
 556          * @param from the node to be checked
 557          * @param to the adjacent node
 558          * @param connect_face a bit field indicating which face of the node is
 559          * adjacent to the other node.
 560          * Bits: +y (least significant), -y, -z, -x, +z, +x (most significant).
 561          * @return true if the node connects, false otherwise
 562          */
 563         bool nodeboxConnects(MapNode from, MapNode to,
 564                         u8 connect_face) const;
 565
 566         /*!
 567          * Registers a NodeResolver to wait for the registration of
 568          * ContentFeatures. Once the node registration finishes, all
 569          * listeners are notified.
 570          */
 571         void pendNodeResolve(NodeResolver *nr) const;
 572
 573         /*!
 574          * Stops listening to the NodeDefManager.
 575          * @return true if the listener was registered before, false otherwise
 576          */
 577         bool cancelNodeResolveCallback(NodeResolver *nr) const;
 578
 579         /*!
 580          * Registers a new node type with the given name and allocates a new
 581          * content ID.
 582          * Should not be called with an already existing name.
 583          * @param name name of the node, must match with `def.name`.
 584          * @param def definition of the registered node type.
 585          * @return ID of the registered node or @ref CONTENT_IGNORE if
 586          * the function could not allocate an ID.
 587          */
 588         content_t set(const std::string &name, const ContentFeatures &def);
 589
 590         /*!
 591          * Allocates a blank node ID for the given name.
 592          * @param name name of a node
 593          * @return allocated ID or @ref CONTENT_IGNORE if could not allocate
 594          * an ID.
 595          */
 596         content_t allocateDummy(const std::string &name);
 597
 598         /*!
 599          * Removes the given node name from the manager.
 600          * The node ID will remain in the manager, but won't be linked to any name.
 601          * @param name name to be removed
 602          */
 603         void removeNode(const std::string &name);
 604
 605         /*!
 606          * Regenerates the alias list (a map from names to node IDs).
 607          * @param idef the item definition manager containing alias information
 608          */
 609         void updateAliases(IItemDefManager *idef);
 610
 611         /*!
 612          * Replaces the textures of registered nodes with the ones specified in
 613          * the texturepack's override.txt file
 614          *
 615          * @param overrides the texture overrides
 616          */
 617         void applyTextureOverrides(const std::vector<TextureOverride> &overrides);
 618
 619         /*!
 620          * Only the client uses this. Loads textures and shaders required for
 621          * rendering the nodes.
 622          * @param gamedef must be a Client.
 623          * @param progress_cbk called each time a node is loaded. Arguments:
 624          * `progress_cbk_args`, number of loaded ContentFeatures, number of
 625          * total ContentFeatures.
 626          * @param progress_cbk_args passed to the callback function
 627          */
 628         void updateTextures(IGameDef *gamedef,
 629                 void (*progress_cbk)(void *progress_args, u32 progress, u32 max_progress),
 630                 void *progress_cbk_args);
 631
 632         /*!
 633          * Writes the content of this manager to the given output stream.
 634          * @param protocol_version serialization version of ContentFeatures
 635          */
 636         void serialize(std::ostream &os, u16 protocol_version) const;
 637
 638         /*!
 639          * Restores the manager from a serialized stream.
 640          * This clears the previous state.
 641          * @param is input stream containing a serialized NodeDefManager
 642          */
 643         void deSerialize(std::istream &is);
 644
 645         /*!
 646          * Used to indicate that node registration has finished.
 647          * @param completed tells whether registration is complete
 648          */
 649         inline void setNodeRegistrationStatus(bool completed) {
 650                 m_node_registration_complete = completed;
 651         }
 652
 653         /*!
 654          * Notifies the registered NodeResolver instances that node registration
 655          * has finished, then unregisters all listeners.
 656          * Must be called after node registration has finished!
 657          */
 658         void runNodeResolveCallbacks();
 659
 660         /*!
 661          * Sets the registration completion flag to false and unregisters all
 662          * NodeResolver instances listening to the manager.
 663          */
 664         void resetNodeResolveState();
 665
 666         /*!
 667          * Resolves (caches the IDs) cross-references between nodes,
 668          * like liquid alternatives.
 669          * Must be called after node registration has finished!
 670          */
 671         void resolveCrossrefs();
 672
 673 private:
 674         /*!
 675          * Resets the manager to its initial state.
 676          * See the documentation of the constructor.
 677          */
 678         void clear();
 679
 680         /*!
 681          * Allocates a new content ID, and returns it.
 682          * @return the allocated ID or \ref CONTENT_IGNORE if could not allocate
 683          */
 684         content_t allocateId();
 685
 686         /*!
 687          * Binds the given content ID and node name.
 688          * Registers them in \ref m_name_id_mapping and
 689          * \ref m_name_id_mapping_with_aliases.
 690          * @param i a content ID
 691          * @param name a node name
 692          */
 693         void addNameIdMapping(content_t i, std::string name);
 694
 695         /*!
 696          * Removes a content ID from all groups.
 697          * Erases content IDs from vectors in \ref m_group_to_items and
 698          * removes empty vectors.
 699          * @param id Content ID
 700          */
 701         void eraseIdFromGroups(content_t id);
 702
 703         /*!
 704          * Recalculates m_selection_box_int_union based on
 705          * m_selection_box_union.
 706          */
 707         void fixSelectionBoxIntUnion();
 708
 709         //! Features indexed by ID.
 710         std::vector<ContentFeatures> m_content_features;
 711
 712         //! A mapping for fast conversion between names and IDs
 713         NameIdMapping m_name_id_mapping;
 714
 715         /*!
 716          * Like @ref m_name_id_mapping, but maps only from names to IDs, and
 717          * includes aliases too. Updated by \ref updateAliases().
 718          * Note: Not serialized.
 719          */
 720         std::unordered_map<std::string, content_t> m_name_id_mapping_with_aliases;
 721
 722         /*!
 723          * A mapping from group names to a vector of content types that belong
 724          * to it. Necessary for a direct lookup in \ref getIds().
 725          * Note: Not serialized.
 726          */
 727         std::unordered_map<std::string, std::vector<content_t>> m_group_to_items;
 728
 729         /*!
 730          * The next ID that might be free to allocate.
 731          * It can be allocated already, because \ref CONTENT_AIR,
 732          * \ref CONTENT_UNKNOWN and \ref CONTENT_IGNORE are registered when the
 733          * manager is initialized, and new IDs are allocated from 0.
 734          */
 735         content_t m_next_id;
 736
 737         //! True if all nodes have been registered.
 738         bool m_node_registration_complete;
 739
 740         /*!
 741          * The union of all nodes' selection boxes.
 742          * Might be larger if big nodes are removed from the manager.
 743          */
 744         aabb3f m_selection_box_union;
 745
 746         /*!
 747          * The smallest box in integer node coordinates that
 748          * contains all nodes' selection boxes.
 749          * Might be larger if big nodes are removed from the manager.
 750          */
 751         core::aabbox3d<s16> m_selection_box_int_union;
 752
 753         /*!
 754          * NodeResolver instances to notify once node registration has finished.
 755          * Even constant NodeDefManager instances can register listeners.
 756          */
 757         mutable std::vector<NodeResolver *> m_pending_resolve_callbacks;
 758 };
 759
 760 NodeDefManager *createNodeDefManager();
 761
 762 class NodeResolver {
 763 public:
 764         NodeResolver();
 765         virtual ~NodeResolver();
 766         virtual void resolveNodeNames() = 0;
 767
 768         // required because this class is used as mixin for ObjDef
 769         void cloneTo(NodeResolver *res) const;
 770
 771         bool getIdFromNrBacklog(content_t *result_out,
 772                 const std::string &node_alt, content_t c_fallback,
 773                 bool error_on_fallback = true);
 774         bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
 775                 bool all_required = false, content_t c_fallback = CONTENT_IGNORE);
 776
 777         void nodeResolveInternal();
 778
 779         u32 m_nodenames_idx = 0;
 780         u32 m_nnlistsizes_idx = 0;
 781         std::vector<std::string> m_nodenames;
 782         std::vector<size_t> m_nnlistsizes;
 783         const NodeDefManager *m_ndef = nullptr;
 784         bool m_resolve_done = false;
 785 };