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 #define CF_SPECIAL_COUNT 6
 265
 266 struct ContentFeatures
 267 {
 268         /*
 269                 Cached stuff
 270          */
 271 #ifndef SERVER
 272         // 0     1     2     3     4     5
 273         // up    down  right left  back  front
 274         TileSpec tiles[6];
 275         // Special tiles
 276         // - Currently used for flowing liquids
 277         TileSpec special_tiles[CF_SPECIAL_COUNT];
 278         u8 solidness; // Used when choosing which face is drawn
 279         u8 visual_solidness; // When solidness=0, this tells how it looks like
 280         bool backface_culling;
 281 #endif
 282
 283         // Server-side cached callback existence for fast skipping
 284         bool has_on_construct;
 285         bool has_on_destruct;
 286         bool has_after_destruct;
 287
 288         /*
 289                 Actual data
 290          */
 291
 292         // --- GENERAL PROPERTIES ---
 293
 294         std::string name; // "" = undefined node
 295         ItemGroupList groups; // Same as in itemdef
 296         // Type of MapNode::param1
 297         ContentParamType param_type;
 298         // Type of MapNode::param2
 299         ContentParamType2 param_type_2;
 300
 301         // --- VISUAL PROPERTIES ---
 302
 303         enum NodeDrawType drawtype;
 304         std::string mesh;
 305 #ifndef SERVER
 306         scene::IMesh *mesh_ptr[24];
 307         video::SColor minimap_color;
 308 #endif
 309         float visual_scale; // Misc. scale parameter
 310         TileDef tiledef[6];
 311         // These will be drawn over the base tiles.
 312         TileDef tiledef_overlay[6];
 313         TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
 314         // If 255, the node is opaque.
 315         // Otherwise it uses texture alpha.
 316         u8 alpha;
 317         // The color of the node.
 318         video::SColor color;
 319         std::string palette_name;
 320         std::vector<video::SColor> *palette;
 321         // Used for waving leaves/plants
 322         u8 waving;
 323         // for NDT_CONNECTED pairing
 324         u8 connect_sides;
 325         std::vector<std::string> connects_to;
 326         std::vector<content_t> connects_to_ids;
 327         // Post effect color, drawn when the camera is inside the node.
 328         video::SColor post_effect_color;
 329         // Flowing liquid or leveled nodebox, value = default level
 330         u8 leveled;
 331         // Maximum value for leveled nodes
 332         u8 leveled_max;
 333
 334         // --- LIGHTING-RELATED ---
 335
 336         bool light_propagates;
 337         bool sunlight_propagates;
 338         // Amount of light the node emits
 339         u8 light_source;
 340
 341         // --- MAP GENERATION ---
 342
 343         // True for all ground-like things like stone and mud, false for eg. trees
 344         bool is_ground_content;
 345
 346         // --- INTERACTION PROPERTIES ---
 347
 348         // This is used for collision detection.
 349         // Also for general solidness queries.
 350         bool walkable;
 351         // Player can point to these
 352         bool pointable;
 353         // Player can dig these
 354         bool diggable;
 355         // Player can climb these
 356         bool climbable;
 357         // Player can build on these
 358         bool buildable_to;
 359         // Player cannot build to these (placement prediction disabled)
 360         bool rightclickable;
 361         u32 damage_per_second;
 362         // client dig prediction
 363         std::string node_dig_prediction;
 364
 365         // --- LIQUID PROPERTIES ---
 366
 367         // Whether the node is non-liquid, source liquid or flowing liquid
 368         enum LiquidType liquid_type;
 369         // If the content is liquid, this is the flowing version of the liquid.
 370         std::string liquid_alternative_flowing;
 371         content_t liquid_alternative_flowing_id;
 372         // If the content is liquid, this is the source version of the liquid.
 373         std::string liquid_alternative_source;
 374         content_t liquid_alternative_source_id;
 375         // Viscosity for fluid flow, ranging from 1 to 7, with
 376         // 1 giving almost instantaneous propagation and 7 being
 377         // the slowest possible
 378         u8 liquid_viscosity;
 379         // Is liquid renewable (new liquid source will be created between 2 existing)
 380         bool liquid_renewable;
 381         // Number of flowing liquids surrounding source
 382         u8 liquid_range;
 383         u8 drowning;
 384         // Liquids flow into and replace node
 385         bool floodable;
 386
 387         // --- NODEBOXES ---
 388
 389         NodeBox node_box;
 390         NodeBox selection_box;
 391         NodeBox collision_box;
 392
 393         // --- SOUND PROPERTIES ---
 394
 395         SimpleSoundSpec sound_footstep;
 396         SimpleSoundSpec sound_dig;
 397         SimpleSoundSpec sound_dug;
 398
 399         // --- LEGACY ---
 400
 401         // Compatibility with old maps
 402         // Set to true if paramtype used to be 'facedir_simple'
 403         bool legacy_facedir_simple;
 404         // Set to true if wall_mounted used to be set to true
 405         bool legacy_wallmounted;
 406
 407         /*
 408                 Methods
 409         */
 410
 411         ContentFeatures();
 412         ~ContentFeatures() = default;
 413         void reset();
 414         void serialize(std::ostream &os, u16 protocol_version) const;
 415         void deSerialize(std::istream &is);
 416         /*!
 417          * Since vertex alpha is no longer supported, this method
 418          * adds opacity directly to the texture pixels.
 419          *
 420          * \param tiles array of the tile definitions.
 421          * \param length length of tiles
 422          */
 423         void correctAlpha(TileDef *tiles, int length);
 424
 425         /*
 426                 Some handy methods
 427         */
 428         bool isLiquid() const{
 429                 return (liquid_type != LIQUID_NONE);
 430         }
 431         bool sameLiquid(const ContentFeatures &f) const{
 432                 if(!isLiquid() || !f.isLiquid()) return false;
 433                 return (liquid_alternative_flowing_id == f.liquid_alternative_flowing_id);
 434         }
 435
 436         int getGroup(const std::string &group) const
 437         {
 438                 return itemgroup_get(groups, group);
 439         }
 440
 441 #ifndef SERVER
 442         void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
 443                 scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
 444 #endif
 445 };
 446
 447 /*!
 448  * @brief This class is for getting the actual properties of nodes from their
 449  * content ID.
 450  *
 451  * @details The nodes on the map are represented by three numbers (see MapNode).
 452  * The first number (param0) is the type of a node. All node types have own
 453  * properties (see ContentFeatures). This class is for storing and getting the
 454  * properties of nodes.
 455  * The manager is first filled with registered nodes, then as the game begins,
 456  * functions only get `const` pointers to it, to prevent modification of
 457  * registered nodes.
 458  */
 459 class NodeDefManager {
 460 public:
 461         /*!
 462          * Creates a NodeDefManager, and registers three ContentFeatures:
 463          * \ref CONTENT_AIR, \ref CONTENT_UNKNOWN and \ref CONTENT_IGNORE.
 464          */
 465         NodeDefManager();
 466         ~NodeDefManager();
 467
 468         /*!
 469          * Returns the properties for the given content type.
 470          * @param c content type of a node
 471          * @return properties of the given content type, or \ref CONTENT_UNKNOWN
 472          * if the given content type is not registered.
 473          */
 474         inline const ContentFeatures& get(content_t c) const {
 475                 return
 476                         c < m_content_features.size() ?
 477                                 m_content_features[c] : m_content_features[CONTENT_UNKNOWN];
 478         }
 479
 480         /*!
 481          * Returns the properties of the given node.
 482          * @param n a map node
 483          * @return properties of the given node or @ref CONTENT_UNKNOWN if the
 484          * given content type is not registered.
 485          */
 486         inline const ContentFeatures& get(const MapNode &n) const {
 487                 return get(n.getContent());
 488         }
 489
 490         /*!
 491          * Returns the node properties for a node name.
 492          * @param name name of a node
 493          * @return properties of the given node or @ref CONTENT_UNKNOWN if
 494          * not found
 495          */
 496         const ContentFeatures& get(const std::string &name) const;
 497
 498         /*!
 499          * Returns the content ID for the given name.
 500          * @param name a node name
 501          * @param[out] result will contain the content ID if found, otherwise
 502          * remains unchanged
 503          * @return true if the ID was found, false otherwise
 504          */
 505         bool getId(const std::string &name, content_t &result) const;
 506
 507         /*!
 508          * Returns the content ID for the given name.
 509          * @param name a node name
 510          * @return ID of the node or @ref CONTENT_IGNORE if not found
 511          */
 512         content_t getId(const std::string &name) const;
 513
 514         /*!
 515          * Returns the content IDs of the given node name or node group name.
 516          * Group names start with "group:".
 517          * @param name a node name or node group name
 518          * @param[out] result will be appended with matching IDs
 519          * @return true if `name` is a valid node name or a (not necessarily
 520          * valid) group name
 521          */
 522         bool getIds(const std::string &name, std::vector<content_t> &result) const;
 523
 524         /*!
 525          * Returns the smallest box in integer node coordinates that
 526          * contains all nodes' selection boxes. The returned box might be larger
 527          * than the minimal size if the largest node is removed from the manager.
 528          */
 529         inline core::aabbox3d<s16> getSelectionBoxIntUnion() const {
 530                 return m_selection_box_int_union;
 531         }
 532
 533         /*!
 534          * Checks whether a node connects to an adjacent node.
 535          * @param from the node to be checked
 536          * @param to the adjacent node
 537          * @param connect_face a bit field indicating which face of the node is
 538          * adjacent to the other node.
 539          * Bits: +y (least significant), -y, -z, -x, +z, +x (most significant).
 540          * @return true if the node connects, false otherwise
 541          */
 542         bool nodeboxConnects(MapNode from, MapNode to,
 543                         u8 connect_face) const;
 544
 545         /*!
 546          * Registers a NodeResolver to wait for the registration of
 547          * ContentFeatures. Once the node registration finishes, all
 548          * listeners are notified.
 549          */
 550         void pendNodeResolve(NodeResolver *nr) const;
 551
 552         /*!
 553          * Stops listening to the NodeDefManager.
 554          * @return true if the listener was registered before, false otherwise
 555          */
 556         bool cancelNodeResolveCallback(NodeResolver *nr) const;
 557
 558         /*!
 559          * Registers a new node type with the given name and allocates a new
 560          * content ID.
 561          * Should not be called with an already existing name.
 562          * @param name name of the node, must match with `def.name`.
 563          * @param def definition of the registered node type.
 564          * @return ID of the registered node or @ref CONTENT_IGNORE if
 565          * the function could not allocate an ID.
 566          */
 567         content_t set(const std::string &name, const ContentFeatures &def);
 568
 569         /*!
 570          * Allocates a blank node ID for the given name.
 571          * @param name name of a node
 572          * @return allocated ID or @ref CONTENT_IGNORE if could not allocate
 573          * an ID.
 574          */
 575         content_t allocateDummy(const std::string &name);
 576
 577         /*!
 578          * Removes the given node name from the manager.
 579          * The node ID will remain in the manager, but won't be linked to any name.
 580          * @param name name to be removed
 581          */
 582         void removeNode(const std::string &name);
 583
 584         /*!
 585          * Regenerates the alias list (a map from names to node IDs).
 586          * @param idef the item definition manager containing alias information
 587          */
 588         void updateAliases(IItemDefManager *idef);
 589
 590         /*!
 591          * Replaces the textures of registered nodes with the ones specified in
 592          * the texturepack's override.txt file
 593          *
 594          * @param overrides the texture overrides
 595          */
 596         void applyTextureOverrides(const std::vector<TextureOverride> &overrides);
 597
 598         /*!
 599          * Only the client uses this. Loads textures and shaders required for
 600          * rendering the nodes.
 601          * @param gamedef must be a Client.
 602          * @param progress_cbk called each time a node is loaded. Arguments:
 603          * `progress_cbk_args`, number of loaded ContentFeatures, number of
 604          * total ContentFeatures.
 605          * @param progress_cbk_args passed to the callback function
 606          */
 607         void updateTextures(IGameDef *gamedef,
 608                 void (*progress_cbk)(void *progress_args, u32 progress, u32 max_progress),
 609                 void *progress_cbk_args);
 610
 611         /*!
 612          * Writes the content of this manager to the given output stream.
 613          * @param protocol_version serialization version of ContentFeatures
 614          */
 615         void serialize(std::ostream &os, u16 protocol_version) const;
 616
 617         /*!
 618          * Restores the manager from a serialized stream.
 619          * This clears the previous state.
 620          * @param is input stream containing a serialized NodeDefManager
 621          */
 622         void deSerialize(std::istream &is);
 623
 624         /*!
 625          * Used to indicate that node registration has finished.
 626          * @param completed tells whether registration is complete
 627          */
 628         inline void setNodeRegistrationStatus(bool completed) {
 629                 m_node_registration_complete = completed;
 630         }
 631
 632         /*!
 633          * Notifies the registered NodeResolver instances that node registration
 634          * has finished, then unregisters all listeners.
 635          * Must be called after node registration has finished!
 636          */
 637         void runNodeResolveCallbacks();
 638
 639         /*!
 640          * Sets the registration completion flag to false and unregisters all
 641          * NodeResolver instances listening to the manager.
 642          */
 643         void resetNodeResolveState();
 644
 645         /*!
 646          * Resolves (caches the IDs) cross-references between nodes,
 647          * like liquid alternatives.
 648          * Must be called after node registration has finished!
 649          */
 650         void resolveCrossrefs();
 651
 652 private:
 653         /*!
 654          * Resets the manager to its initial state.
 655          * See the documentation of the constructor.
 656          */
 657         void clear();
 658
 659         /*!
 660          * Allocates a new content ID, and returns it.
 661          * @return the allocated ID or \ref CONTENT_IGNORE if could not allocate
 662          */
 663         content_t allocateId();
 664
 665         /*!
 666          * Binds the given content ID and node name.
 667          * Registers them in \ref m_name_id_mapping and
 668          * \ref m_name_id_mapping_with_aliases.
 669          * @param i a content ID
 670          * @param name a node name
 671          */
 672         void addNameIdMapping(content_t i, std::string name);
 673
 674         /*!
 675          * Removes a content ID from all groups.
 676          * Erases content IDs from vectors in \ref m_group_to_items and
 677          * removes empty vectors.
 678          * @param id Content ID
 679          */
 680         void eraseIdFromGroups(content_t id);
 681
 682         /*!
 683          * Recalculates m_selection_box_int_union based on
 684          * m_selection_box_union.
 685          */
 686         void fixSelectionBoxIntUnion();
 687
 688         //! Features indexed by ID.
 689         std::vector<ContentFeatures> m_content_features;
 690
 691         //! A mapping for fast conversion between names and IDs
 692         NameIdMapping m_name_id_mapping;
 693
 694         /*!
 695          * Like @ref m_name_id_mapping, but maps only from names to IDs, and
 696          * includes aliases too. Updated by \ref updateAliases().
 697          * Note: Not serialized.
 698          */
 699         std::unordered_map<std::string, content_t> m_name_id_mapping_with_aliases;
 700
 701         /*!
 702          * A mapping from group names to a vector of content types that belong
 703          * to it. Necessary for a direct lookup in \ref getIds().
 704          * Note: Not serialized.
 705          */
 706         std::unordered_map<std::string, std::vector<content_t>> m_group_to_items;
 707
 708         /*!
 709          * The next ID that might be free to allocate.
 710          * It can be allocated already, because \ref CONTENT_AIR,
 711          * \ref CONTENT_UNKNOWN and \ref CONTENT_IGNORE are registered when the
 712          * manager is initialized, and new IDs are allocated from 0.
 713          */
 714         content_t m_next_id;
 715
 716         //! True if all nodes have been registered.
 717         bool m_node_registration_complete;
 718
 719         /*!
 720          * The union of all nodes' selection boxes.
 721          * Might be larger if big nodes are removed from the manager.
 722          */
 723         aabb3f m_selection_box_union;
 724
 725         /*!
 726          * The smallest box in integer node coordinates that
 727          * contains all nodes' selection boxes.
 728          * Might be larger if big nodes are removed from the manager.
 729          */
 730         core::aabbox3d<s16> m_selection_box_int_union;
 731
 732         /*!
 733          * NodeResolver instances to notify once node registration has finished.
 734          * Even constant NodeDefManager instances can register listeners.
 735          */
 736         mutable std::vector<NodeResolver *> m_pending_resolve_callbacks;
 737 };
 738
 739 NodeDefManager *createNodeDefManager();
 740
 741 class NodeResolver {
 742 public:
 743         NodeResolver();
 744         virtual ~NodeResolver();
 745         virtual void resolveNodeNames() = 0;
 746
 747         // required because this class is used as mixin for ObjDef
 748         void cloneTo(NodeResolver *res) const;
 749
 750         bool getIdFromNrBacklog(content_t *result_out,
 751                 const std::string &node_alt, content_t c_fallback,
 752                 bool error_on_fallback = true);
 753         bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
 754                 bool all_required = false, content_t c_fallback = CONTENT_IGNORE);
 755
 756         void nodeResolveInternal();
 757
 758         u32 m_nodenames_idx = 0;
 759         u32 m_nnlistsizes_idx = 0;
 760         std::vector<std::string> m_nodenames;
 761         std::vector<size_t> m_nnlistsizes;
 762         const NodeDefManager *m_ndef = nullptr;
 763         bool m_resolve_done = false;
 764 };