nodedef.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
#pragma once
 
#include <functional>
#include <string>
#include <iostream>
#include <memory> // shared_ptr
#include "mapnode.h"
#include "nameidmapping.h"
#include "itemgroup.h"
#include "sound_spec.h"
#include "texture_override.h" // TextureOverride
#include "tileanimation.h"
#include "util/pointabilities.h"
 
class IItemDefManager;
class ITextureSource;
class IShaderSource;
class IGameDef;
class NodeResolver;
#if BUILD_UNITTESTS
class TestSchematic;
#endif
#if CHECK_CLIENT_BUILD()
struct NodeVisuals;
#endif
 
enum ContentParamType : u8
{
        CPT_NONE,
        CPT_LIGHT,
        ContentParamType_END // Dummy for validity check
};
 
enum ContentParamType2 : u8
{
        CPT2_NONE,
        // Need 8-bit param2
        CPT2_FULL,
        // Flowing liquid properties
        CPT2_FLOWINGLIQUID,
        // Direction for chests and furnaces and such (with axis rotation)
        CPT2_FACEDIR,
        // Direction for signs, torches and such
        CPT2_WALLMOUNTED,
        // Block level like FLOWINGLIQUID
        CPT2_LEVELED,
        // 2D rotation
        CPT2_DEGROTATE,
        // Mesh options for plants
        CPT2_MESHOPTIONS,
        // Index for palette
        CPT2_COLOR,
        // 3 bits of palette index, then facedir
        CPT2_COLORED_FACEDIR,
        // 5 bits of palette index, then wallmounted
        CPT2_COLORED_WALLMOUNTED,
        // Glasslike framed drawtype internal liquid level, param2 values 0 to 63
        CPT2_GLASSLIKE_LIQUID_LEVEL,
        // 3 bits of palette index, then degrotate
        CPT2_COLORED_DEGROTATE,
        // Simplified direction for chests and furnaces and such (4 directions)
        CPT2_4DIR,
        // 6 bits of palette index, then 4dir
        CPT2_COLORED_4DIR,
        // Dummy for validity check
        ContentParamType2_END
};
 
enum LiquidType : u8
{
        LIQUID_NONE,
        LIQUID_FLOWING,
        LIQUID_SOURCE,
        LiquidType_END // Dummy for validity check
};
 
enum NodeBoxType : u8
{
        NODEBOX_REGULAR, // Regular block; allows buildable_to
        NODEBOX_FIXED, // Static separately defined box(es)
        NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
        NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
        NODEBOX_CONNECTED, // optionally draws nodeboxes if a neighbor node attaches
};
 
struct NodeBoxConnected
{
        std::vector<aabb3f> connect_top;
        std::vector<aabb3f> connect_bottom;
        std::vector<aabb3f> connect_front;
        std::vector<aabb3f> connect_left;
        std::vector<aabb3f> connect_back;
        std::vector<aabb3f> connect_right;
        std::vector<aabb3f> disconnected_top;
        std::vector<aabb3f> disconnected_bottom;
        std::vector<aabb3f> disconnected_front;
        std::vector<aabb3f> disconnected_left;
        std::vector<aabb3f> disconnected_back;
        std::vector<aabb3f> disconnected_right;
        std::vector<aabb3f> disconnected;
        std::vector<aabb3f> disconnected_sides;
};
 
struct NodeBox
{
        enum NodeBoxType type;
        // NODEBOX_REGULAR (no parameters)
        // NODEBOX_FIXED
        std::vector<aabb3f> fixed;
        // NODEBOX_WALLMOUNTED
        aabb3f wall_top = dummybox;
        aabb3f wall_bottom = dummybox;
        aabb3f wall_side = dummybox; // being at the -X side
        // NODEBOX_CONNECTED
        // (kept externally to not bloat the structure)
        std::shared_ptr<NodeBoxConnected> connected;
 
        NodeBox()
        { reset(); }
        ~NodeBox() = default;
 
        inline NodeBoxConnected &getConnected() {
                if (!connected)
                        connected = std::make_shared<NodeBoxConnected>();
                return *connected;
        }
        inline const NodeBoxConnected &getConnected() const {
                assert(connected);
                return *connected;
        }
 
        void reset();
        void serialize(std::ostream &os, u16 protocol_version) const;
        void deSerialize(std::istream &is);
 
private:
        static constexpr aabb3f dummybox = aabb3f({0, 0, 0});
};
 
struct MapNode;
 
enum LeavesStyle {
        LEAVES_FANCY,
        LEAVES_SIMPLE,
        LEAVES_OPAQUE,
};
 
enum AutoScale : u8 {
        AUTOSCALE_DISABLE,
        AUTOSCALE_ENABLE,
        AUTOSCALE_FORCE,
};
 
enum WorldAlignMode : u8 {
        WORLDALIGN_DISABLE,
        WORLDALIGN_ENABLE,
        WORLDALIGN_FORCE,
        WORLDALIGN_FORCE_NODEBOX,
};
 
class TextureSettings {
public:
        LeavesStyle leaves_style;
        WorldAlignMode world_aligned_mode;
        AutoScale autoscale_mode;
        int node_texture_size;
        bool translucent_liquids;
        bool connected_glass;
        bool enable_minimap;
 
        TextureSettings() = default;
 
        void readSettings();
};
 
enum NodeDrawType : u8
{
        // A basic solid block
        NDT_NORMAL,
        // Nothing is drawn
        NDT_AIRLIKE,
        // Do not draw face towards same kind of flowing/source liquid
        NDT_LIQUID,
        // A very special kind of thing
        NDT_FLOWINGLIQUID,
        // Glass-like, don't draw faces towards other glass
        NDT_GLASSLIKE,
        // Leaves-like, draw all faces no matter what
        NDT_ALLFACES,
        // Enabled -> ndt_allfaces, disabled -> ndt_normal
        NDT_ALLFACES_OPTIONAL,
        // Single plane perpendicular to a surface
        NDT_TORCHLIKE,
        // Single plane parallel to a surface
        NDT_SIGNLIKE,
        // 2 vertical planes in a 'X' shape diagonal to XZ axes.
        // paramtype2 = "meshoptions" allows various forms, sizes and
        // vertical and horizontal random offsets.
        NDT_PLANTLIKE,
        // Fenceposts that connect to neighboring fenceposts with horizontal bars
        NDT_FENCELIKE,
        // Selects appropriate junction texture to connect like rails to
        // neighboring raillikes.
        NDT_RAILLIKE,
        // Custom Lua-definable structure of multiple cuboids
        NDT_NODEBOX,
        // Glass-like, draw connected frames and all visible faces.
        // param2 > 0 defines 64 levels of internal liquid
        // Uses 3 textures, one for frames, second for faces,
        // optional third is a 'special tile' for the liquid.
        NDT_GLASSLIKE_FRAMED,
        // Draw faces slightly rotated and only on neighboring nodes
        NDT_FIRELIKE,
        // Enabled -> ndt_glasslike_framed, disabled -> ndt_glasslike
        NDT_GLASSLIKE_FRAMED_OPTIONAL,
        // Uses static meshes
        NDT_MESH,
        // Combined plantlike-on-solid
        NDT_PLANTLIKE_ROOTED,
 
        // Dummy for validity check
        NodeDrawType_END
};
 
// Mesh options for NDT_PLANTLIKE with CPT2_MESHOPTIONS
static const u8 MO_MASK_STYLE          = 0x07;
static const u8 MO_BIT_RANDOM_OFFSET   = 0x08;
static const u8 MO_BIT_SCALE_SQRT2     = 0x10;
static const u8 MO_BIT_RANDOM_OFFSET_Y = 0x20;
enum PlantlikeStyle {
        PLANT_STYLE_CROSS,
        PLANT_STYLE_CROSS2,
        PLANT_STYLE_STAR,
        PLANT_STYLE_HASH,
        PLANT_STYLE_HASH2,
};
 
enum AlignStyle : u8 {
        ALIGN_STYLE_NODE,
        ALIGN_STYLE_WORLD,
        ALIGN_STYLE_USER_DEFINED,
        AlignStyle_END // Dummy for validity check
};
 
enum AlphaMode : u8 {
        ALPHAMODE_BLEND,
        ALPHAMODE_CLIP,
        ALPHAMODE_OPAQUE,
        ALPHAMODE_LEGACY_COMPAT, /* only sent by old servers, equals OPAQUE */
        AlphaMode_END // Dummy for validity check
};
 
/*
        Stand-alone definition of a TileSpec (basically a server-side TileSpec)
*/
 
struct TileDef
{
        std::string name = "";
        bool backface_culling = true; // Takes effect only in special cases
        bool tileable_horizontal = true;
        bool tileable_vertical = true;
        bool has_color = false;
        video::SColor color = video::SColor(0xFFFFFFFF);
        AlignStyle align_style = ALIGN_STYLE_NODE;
        u8 scale = 0;
 
        struct TileAnimationParams animation;
 
        TileDef()
        {
                animation.type = TAT_NONE;
        }
 
        void serialize(std::ostream &os, u16 protocol_version) const;
        void deSerialize(std::istream &is, NodeDrawType drawtype, u16 protocol_version);
};
 
// Defines the number of special tiles per nodedef
//
// NOTE: When changing this value, the enum entries of OverrideTarget and
//       parser in TextureOverrideSource must be updated so that all special
//       tiles can be overridden.
#define CF_SPECIAL_COUNT 6
 
struct ContentFeatures
{
        // PROTOCOL_VERSION >= 37. This is legacy and should not be increased anymore,
        // write checks that depend directly on the protocol version instead.
        static const u8 CONTENTFEATURES_VERSION = 13;
 
        // Server-side cached callback existence for fast skipping
        bool has_on_construct;
        bool has_on_destruct;
        bool has_after_destruct;
 
        // "float" group
        bool floats;
 
        /*
                Actual data
         */
 
        // --- GENERAL PROPERTIES ---
 
        std::string name; // "" = undefined node
        ItemGroupList groups; // Same as in itemdef
        // Type of MapNode::param1
        ContentParamType param_type;
        // Type of MapNode::param2
        ContentParamType2 param_type_2;
 
        // --- VISUAL PROPERTIES ---
 
        enum NodeDrawType drawtype;
        std::string mesh;
        float visual_scale; // Misc. scale parameter
        TileDef tiledef[6];
        // These will be drawn over the base tiles.
        TileDef tiledef_overlay[6];
        TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
        AlphaMode alpha;
        // The color of the node.
        video::SColor color;
        std::string palette_name;
        // Used for waving leaves/plants
        u8 waving;
        // for NDT_CONNECTED pairing
        u8 connect_sides;
        std::vector<std::string> connects_to;
        std::vector<content_t> connects_to_ids;
        // Post effect color, drawn when the camera is inside the node.
        video::SColor post_effect_color;
        bool post_effect_color_shaded;
        // Flowing liquid or leveled nodebox, value = default level
        u8 leveled;
        // Maximum value for leveled nodes
        u8 leveled_max;
 
        // --- CLIENT ONLY ---
 
#if CHECK_CLIENT_BUILD()
        // The Client class fills this for its NodeDefManager using fillNodeVisuals,
        // thus for ContentFeatures of a Client it is not a nullptr.
        NodeVisuals *visuals = nullptr;
#endif
 
        // --- LIGHTING-RELATED ---
 
        bool light_propagates;
        bool sunlight_propagates;
        // Amount of light the node emits
        u8 light_source;
 
        // --- MAP GENERATION ---
 
        // True for all ground-like things like stone and mud, false for eg. trees
        bool is_ground_content;
 
        // --- INTERACTION PROPERTIES ---
 
        // This is used for collision detection.
        // Also for general solidness queries.
        bool walkable;
        // Player can point to these, point through or it is blocking
        PointabilityType pointable;
        // Player can dig these
        bool diggable;
        // Player can climb these
        bool climbable;
        // Player can build on these
        bool buildable_to;
        // Player cannot build to these (placement prediction disabled)
        bool rightclickable;
        u32 damage_per_second;
        // client dig prediction
        std::string node_dig_prediction;
        // how slow players move through
        u8 move_resistance = 0;
 
        // --- LIQUID PROPERTIES ---
 
        // Whether the node is non-liquid, source liquid or flowing liquid
        enum LiquidType liquid_type;
        // If true, movement (e.g. of players) inside this node is liquid-like.
        bool liquid_move_physics;
        // If the content is liquid, this is the flowing version of the liquid.
        std::string liquid_alternative_flowing;
        content_t liquid_alternative_flowing_id;
        // If the content is liquid, this is the source version of the liquid.
        std::string liquid_alternative_source;
        content_t liquid_alternative_source_id;
        // Viscosity for fluid flow, ranging from 1 to 7, with
        // 1 giving almost instantaneous propagation and 7 being
        // the slowest possible
        u8 liquid_viscosity;
        // Is liquid renewable (new liquid source will be created between 2 existing)
        bool liquid_renewable;
        // Number of flowing liquids surrounding source
        u8 liquid_range;
        u8 drowning;
        // Liquids flow into and replace node
        bool floodable;
 
        // --- NODEBOXES ---
 
        NodeBox node_box;
        NodeBox selection_box;
        NodeBox collision_box;
 
        // --- SOUND PROPERTIES ---
 
        SoundSpec sound_footstep;
        SoundSpec sound_dig;
        SoundSpec sound_dug;
 
        // --- LEGACY ---
 
        // Compatibility with old maps
        // Set to true if paramtype used to be 'facedir_simple'
        bool legacy_facedir_simple;
        // Set to true if wall_mounted used to be set to true
        bool legacy_wallmounted;
 
        /*
                Methods
        */
 
        ContentFeatures();
        ~ContentFeatures();
        void reset();
        void serialize(std::ostream &os, u16 protocol_version) const;
        void deSerialize(std::istream &is, u16 protocol_version);
 
        /*
                Some handy methods
        */
        void setDefaultAlphaMode()
        {
                switch (drawtype) {
                case NDT_NORMAL:
                case NDT_LIQUID:
                case NDT_FLOWINGLIQUID:
                case NDT_NODEBOX:
                case NDT_MESH:
                        alpha = ALPHAMODE_OPAQUE;
                        break;
                default:
                        alpha = ALPHAMODE_CLIP;
                        break;
                }
        }
 
 
        bool isLiquid() const{
                return (liquid_type != LIQUID_NONE);
        }
 
        bool isLiquidRender() const {
                return (drawtype == NDT_LIQUID || drawtype == NDT_FLOWINGLIQUID);
        }
 
        bool sameLiquidRender(const ContentFeatures &f) const {
                if (!isLiquidRender() || !f.isLiquidRender())
                        return false;
                return liquid_alternative_flowing_id == f.liquid_alternative_flowing_id &&
                        liquid_alternative_source_id == f.liquid_alternative_source_id;
        }
 
        ContentLightingFlags getLightingFlags() const {
                ContentLightingFlags flags;
                flags.has_light = param_type == CPT_LIGHT;
                flags.light_propagates = light_propagates;
                flags.sunlight_propagates = sunlight_propagates;
                flags.light_source = light_source;
                return flags;
        }
 
        int getGroup(const std::string &group) const
        {
                return itemgroup_get(groups, group);
        }
 
private:
        void setAlphaFromLegacy(u8 legacy_alpha);
 
        u8 getAlphaForLegacy() const;
};
 
class NodeDefManager {
public:
        NodeDefManager();
 
        inline const ContentFeatures& get(content_t c) const {
                return
                        (c < m_content_features.size() && !m_content_features[c].name.empty()) ?
                                m_content_features[c] : m_content_features[CONTENT_UNKNOWN];
        }
 
        inline const ContentFeatures& get(const MapNode &n) const {
                return get(n.getContent());
        }
 
        inline ContentLightingFlags getLightingFlags(content_t c) const {
                // No bound check is necessary, since the array's length is CONTENT_MAX + 1.
                return m_content_lighting_flag_cache[c];
        }
 
        inline ContentLightingFlags getLightingFlags(const MapNode &n) const {
                return getLightingFlags(n.getContent());
        }
 
        const ContentFeatures& get(const std::string &name) const;
 
        bool getId(const std::string &name, content_t &result) const;
 
        content_t getId(const std::string &name) const;
 
        bool getIds(const std::string &name, std::vector<content_t> &result) const;
 
        inline core::aabbox3d<s16> getSelectionBoxIntUnion() const {
                return m_selection_box_int_union;
        }
 
        bool nodeboxConnects(MapNode from, MapNode to,
                        u8 connect_face) const;
 
        void pendNodeResolve(NodeResolver *nr) const;
 
        bool cancelNodeResolveCallback(NodeResolver *nr) const;
 
        content_t set(const std::string &name, const ContentFeatures &def);
 
        content_t allocateDummy(const std::string &name);
 
        void removeNode(const std::string &name);
 
        void updateAliases(IItemDefManager *idef);
 
        void applyTextureOverrides(const std::vector<TextureOverride> &overrides);
 
        void applyFunction(const std::function<void(ContentFeatures&)> &function);
 
        inline u32 size() const
        {
                return m_content_features.size();
        }
 
        void serialize(std::ostream &os, u16 protocol_version) const;
 
        void deSerialize(std::istream &is, u16 protocol_version);
 
        inline void setNodeRegistrationStatus(bool completed) {
                m_node_registration_complete = completed;
        }
 
        void runNodeResolveCallbacks();
 
        void resetNodeResolveState();
 
        void resolveCrossrefs();
 
#if CHECK_CLIENT_BUILD()
        // Set of all shader IDs used by leaves-like nodes
        // (kind of a hack but is needed for dynamic shadows)
        std::vector<u32> m_leaves_materials;
#endif
 
private:
        void clear();
 
        content_t allocateId();
 
        void addNameIdMapping(content_t i, const std::string &name);
 
        void eraseIdFromGroups(content_t id);
 
        void fixSelectionBoxIntUnion();
 
        std::vector<ContentFeatures> m_content_features;
 
        NameIdMapping m_name_id_mapping;
 
        std::unordered_map<std::string, content_t> m_name_id_mapping_with_aliases;
 
        std::unordered_map<std::string, std::vector<content_t>> m_group_to_items;
 
        content_t m_next_id;
 
        bool m_node_registration_complete;
 
        aabb3f m_selection_box_union{{0.0f, 0.0f, 0.0f}};
 
        core::aabbox3d<s16> m_selection_box_int_union{{0, 0, 0}};
 
        mutable std::vector<NodeResolver *> m_pending_resolve_callbacks;
 
        ContentLightingFlags m_content_lighting_flag_cache[CONTENT_MAX + 1L];
};
 
NodeDefManager *createNodeDefManager();
 
// NodeResolver: Queue for node names which are then translated
// to content_t after the NodeDefManager was initialized
class NodeResolver {
public:
        NodeResolver();
        virtual ~NodeResolver();
        // Callback which is run as soon NodeDefManager is ready
        virtual void resolveNodeNames() = 0;
 
        // required because this class is used as mixin for ObjDef
        void cloneTo(NodeResolver *res) const;
 
        bool getIdFromNrBacklog(content_t *result_out,
                const std::string &node_alt, content_t c_fallback,
                bool error_on_fallback = true);
        bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
                bool all_required = false, content_t c_fallback = CONTENT_IGNORE);
 
        inline bool isResolveDone() const { return m_resolve_done; }
        void reset(bool resolve_done = false);
 
        // Vector containing all node names in the resolve "queue"
        std::vector<std::string> m_nodenames;
        // Specifies the "set size" of node names which are to be processed
        // this is used for getIdsFromNrBacklog
        // TODO: replace or remove
        std::vector<size_t> m_nnlistsizes;
 
protected:
        friend class NodeDefManager; // m_ndef
 
        const NodeDefManager *m_ndef = nullptr;
        // Index of the next "m_nodenames" entry to resolve
        u32 m_nodenames_idx = 0;
 
private:
#if BUILD_UNITTESTS
        // Unittest requires access to m_resolve_done
        friend class TestSchematic;
#endif
        void nodeResolveInternal();
 
        // Index of the next "m_nnlistsizes" entry to process
        u32 m_nnlistsizes_idx = 0;
        bool m_resolve_done = false;
};