]> git.lizzy.rs Git - minetest.git/blobdiff - src/nodedef.h
Snake case for screen options in minetest.conf (#5792)
[minetest.git] / src / nodedef.h
index 1c2f792d8a2a841d4488cbfd1829caebae53b9d6..4669df7f04ae5136ec10fa28ace2198c8d2b1ccd 100644 (file)
@@ -30,10 +30,12 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef SERVER
 #include "client/tile.h"
 #include "shader.h"
+class Client;
 #endif
 #include "itemgroup.h"
 #include "sound.h" // SimpleSoundSpec
 #include "constants.h" // BS
+#include "tileanimation.h"
 
 class INodeDefManager;
 class IItemDefManager;
@@ -65,6 +67,16 @@ enum ContentParamType2
        CPT2_LEVELED,
        // 2D rotation for things like plants
        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,
 };
 
 enum LiquidType
@@ -134,58 +146,87 @@ class TextureSettings {
 
 enum NodeDrawType
 {
-       NDT_NORMAL, // A basic solid block
-       NDT_AIRLIKE, // Nothing is drawn
-       NDT_LIQUID, // Do not draw face towards same kind of flowing/source liquid
-       NDT_FLOWINGLIQUID, // A very special kind of thing
-       NDT_GLASSLIKE, // Glass-like, don't draw faces towards other glass
-       NDT_ALLFACES, // Leaves-like, draw all faces no matter what
-       NDT_ALLFACES_OPTIONAL, // Fancy -> allfaces, fast -> normal
+       // 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 neighbouring fenceposts with horizontal bars
        NDT_FENCELIKE,
+       // Selects appropriate junction texture to connect like rails to
+       // neighbouring raillikes.
        NDT_RAILLIKE,
+       // Custom Lua-definable structure of multiple cuboids
        NDT_NODEBOX,
-       NDT_GLASSLIKE_FRAMED, // Glass-like, draw connected frames and all all
-                             // visible faces
-                                                 // uses 2 textures, one for frames, second for faces
-       NDT_FIRELIKE, // Draw faces slightly rotated and only on connecting nodes,
-       NDT_GLASSLIKE_FRAMED_OPTIONAL,  // enabled -> connected, disabled -> Glass-like
-                                                                       // uses 2 textures, one for frames, second for faces
-       NDT_MESH, // Uses static meshes
+       // 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 neighbouring nodes
+       NDT_FIRELIKE,
+       // Enabled -> ndt_glasslike_framed, disabled -> ndt_glasslike
+       NDT_GLASSLIKE_FRAMED_OPTIONAL,
+       // Uses static meshes
+       NDT_MESH,
+};
+
+// 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,
 };
 
 /*
        Stand-alone definition of a TileSpec (basically a server-side TileSpec)
 */
-enum TileAnimationType{
-       TAT_NONE=0,
-       TAT_VERTICAL_FRAMES=1,
-};
+
 struct TileDef
 {
        std::string name;
        bool backface_culling; // Takes effect only in special cases
        bool tileable_horizontal;
        bool tileable_vertical;
-       struct{
-               enum TileAnimationType type;
-               int aspect_w; // width for aspect ratio
-               int aspect_h; // height for aspect ratio
-               float length; // seconds
-       } animation;
-
-       TileDef()
+       //! If true, the tile has its own color.
+       bool has_color;
+       //! The color of the tile.
+       video::SColor color;
+
+       struct TileAnimationParams animation;
+
+       TileDef() :
+               name(""),
+               backface_culling(true),
+               tileable_horizontal(true),
+               tileable_vertical(true),
+               has_color(false),
+               color(video::SColor(0xFFFFFFFF))
        {
-               name = "";
-               backface_culling = true;
-               tileable_horizontal = true;
-               tileable_vertical = true;
                animation.type = TAT_NONE;
-               animation.aspect_w = 1;
-               animation.aspect_h = 1;
-               animation.length = 1.0;
        }
 
        void serialize(std::ostream &os, u16 protocol_version) const;
@@ -198,7 +239,7 @@ struct ContentFeatures
 {
        /*
                Cached stuff
-       */
+        */
 #ifndef SERVER
        // 0     1     2     3     4     5
        // up    down  right left  back  front
@@ -218,12 +259,19 @@ struct ContentFeatures
 
        /*
                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 ---
 
-       // Visual definition
        enum NodeDrawType drawtype;
        std::string mesh;
 #ifndef SERVER
@@ -232,20 +280,41 @@ struct ContentFeatures
 #endif
        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
+       // If 255, the node is opaque.
+       // Otherwise it uses texture alpha.
        u8 alpha;
-
+       // The color of the node.
+       video::SColor color;
+       std::string palette_name;
+       std::vector<video::SColor> *palette;
+       // Used for waving leaves/plants
+       u8 waving;
+       // for NDT_CONNECTED pairing
+       u8 connect_sides;
+       std::vector<std::string> connects_to;
+       std::set<content_t> connects_to_ids;
        // Post effect color, drawn when the camera is inside the node.
        video::SColor post_effect_color;
+       // Flowing liquid or snow, value = default level
+       u8 leveled;
+
+       // --- LIGHTING-RELATED ---
 
-       // Type of MapNode::param1
-       ContentParamType param_type;
-       // Type of MapNode::param2
-       ContentParamType2 param_type_2;
-       // True for all ground-like things like stone and mud, false for eg. trees
-       bool is_ground_content;
        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;
@@ -257,12 +326,12 @@ struct ContentFeatures
        bool climbable;
        // Player can build on these
        bool buildable_to;
-       // Liquids flow into and replace node
-       bool floodable;
        // Player cannot build to these (placement prediction disabled)
        bool rightclickable;
-       // Flowing liquid or snow, value = default level
-       u8 leveled;
+       u32 damage_per_second;
+
+       // --- LIQUID PROPERTIES ---
+
        // Whether the node is non-liquid, source liquid or flowing liquid
        enum LiquidType liquid_type;
        // If the content is liquid, this is the flowing version of the liquid.
@@ -278,29 +347,28 @@ struct ContentFeatures
        // Number of flowing liquids surrounding source
        u8 liquid_range;
        u8 drowning;
-       // Amount of light the node emits
-       u8 light_source;
-       u32 damage_per_second;
+       // Liquids flow into and replace node
+       bool floodable;
+
+       // --- NODEBOXES ---
+
        NodeBox node_box;
        NodeBox selection_box;
        NodeBox collision_box;
-       // Used for waving leaves/plants
-       u8 waving;
-       // 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;
-       // for NDT_CONNECTED pairing
-       u8 connect_sides;
 
-       // Sound properties
+       // --- SOUND PROPERTIES ---
+
        SimpleSoundSpec sound_footstep;
        SimpleSoundSpec sound_dig;
        SimpleSoundSpec sound_dug;
 
-       std::vector<std::string> connects_to;
-       std::set<content_t> connects_to_ids;
+       // --- 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
@@ -313,6 +381,14 @@ struct ContentFeatures
        void deSerialize(std::istream &is);
        void serializeOld(std::ostream &os, u16 protocol_version) const;
        void deSerializeOld(std::istream &is, int version);
+       /*!
+        * Since vertex alpha is no longer supported, this method
+        * adds opacity directly to the texture pixels.
+        *
+        * \param tiles array of the tile definitions.
+        * \param length length of tiles
+        */
+       void correctAlpha(TileDef *tiles, int length);
 
        /*
                Some handy methods
@@ -325,13 +401,17 @@ struct ContentFeatures
                return (liquid_alternative_flowing == f.liquid_alternative_flowing);
        }
 
+       int getGroup(const std::string &group) const
+       {
+               return itemgroup_get(groups, group);
+       }
+
 #ifndef SERVER
-       void fillTileAttribs(ITextureSource *tsrc, TileSpec *tile, TileDef *tiledef,
+       void fillTileAttribs(ITextureSource *tsrc, TileLayer *tile, TileDef *tiledef,
                u32 shader_id, bool use_normal_texture, bool backface_culling,
-               u8 alpha, u8 material_type);
+               u8 material_type);
        void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
-               scene::ISceneManager *smgr, scene::IMeshManipulator *meshmanip,
-               IGameDef *gamedef, const TextureSettings &tsettings);
+               scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
 #endif
 };
 
@@ -352,11 +432,14 @@ class INodeDefManager {
 
        virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
 
-       virtual bool getNodeRegistrationStatus() const=0;
-
        virtual void pendNodeResolve(NodeResolver *nr)=0;
        virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
        virtual bool nodeboxConnects(const MapNode from, const MapNode to, u8 connect_face)=0;
+       /*!
+        * Returns the smallest box in node coordinates that
+        * contains all nodes' selection boxes.
+        */
+       virtual core::aabbox3d<s16> getSelectionBoxIntUnion() const=0;
 };
 
 class IWritableNodeDefManager : public INodeDefManager {
@@ -382,6 +465,8 @@ class IWritableNodeDefManager : public INodeDefManager {
                        const ContentFeatures &def)=0;
        // If returns CONTENT_IGNORE, could not allocate id
        virtual content_t allocateDummy(const std::string &name)=0;
+       // Remove a node
+       virtual void removeNode(const std::string &name)=0;
 
        /*
                Update item alias mapping.
@@ -404,7 +489,6 @@ class IWritableNodeDefManager : public INodeDefManager {
        virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
        virtual void deSerialize(std::istream &is)=0;
 
-       virtual bool getNodeRegistrationStatus() const=0;
        virtual void setNodeRegistrationStatus(bool completed)=0;
 
        virtual void pendNodeResolve(NodeResolver *nr)=0;
@@ -412,6 +496,7 @@ class IWritableNodeDefManager : public INodeDefManager {
        virtual void runNodeResolveCallbacks()=0;
        virtual void resetNodeResolveState()=0;
        virtual void mapNodeboxConnections()=0;
+       virtual core::aabbox3d<s16> getSelectionBoxIntUnion() const=0;
 };
 
 IWritableNodeDefManager *createNodeDefManager();