/*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef MAPNODE_HEADER
-#define MAPNODE_HEADER
+#pragma once
-#include <iostream>
-#include "common_irrlicht.h"
+#include "irrlichttypes_bloated.h"
#include "light.h"
-#include "utility.h"
-#include "exceptions.h"
-#include "serialization.h"
+#include "util/pointer.h"
+#include <string>
+#include <vector>
-// Size of node in rendering units
-#define BS 10
+class NodeDefManager;
+class Map;
-#define MATERIALS_COUNT 256
+/*
+ Naming scheme:
+ - Material = irrlicht's Material class
+ - Content = (content_t) content of a node
+ - Tile = TileSpec at some side of a node of some content type
+*/
+typedef u16 content_t;
/*
- Ignored node.
+ The maximum node ID that can be registered by mods. This must
+ be significantly lower than the maximum content_t value, so that
+ there is enough room for dummy node IDs, which are created when
+ a MapBlock containing unknown node names is loaded from disk.
+*/
+#define MAX_REGISTERED_CONTENT 0x7fffU
- Anything that stores MapNodes doesn't have to preserve parameters
- associated with this material.
-
- Doesn't create faces with anything and is considered being
- out-of-map in the game map.
+/*
+ A solid walkable node with the texture unknown_node.png.
+
+ For example, used on the client to display unregistered node IDs
+ (instead of expanding the vector of node definitions each time
+ such a node is received).
*/
-#define MATERIAL_IGNORE 255
-#define MATERIAL_IGNORE_DEFAULT_PARAM 0
+#define CONTENT_UNKNOWN 125
/*
The common material through which the player can walk and which
is transparent to light
*/
-#define MATERIAL_AIR 254
+#define CONTENT_AIR 126
/*
- Materials-todo:
+ Ignored node.
- GRAVEL
- - Dynamics of gravel: if there is a drop of more than two
- blocks on any side, it will drop in there. Is this doable?
+ Unloaded chunks are considered to consist of this. Several other
+ methods return this when an error occurs. Also, during
+ map generation this means the node has not been set yet.
+
+ Doesn't create faces with anything and is considered being
+ out-of-map in the game map.
*/
+#define CONTENT_IGNORE 127
-enum Material
+enum LightBank
{
- MATERIAL_STONE=0,
-
- MATERIAL_GRASS,
-
- MATERIAL_WATER,
-
- MATERIAL_LIGHT,
-
- MATERIAL_TREE,
-
- MATERIAL_LEAVES,
-
- MATERIAL_GRASS_FOOTSTEPS,
-
- MATERIAL_MESE,
-
- MATERIAL_MUD,
-
- // This is set to the number of the actual values in this enum
- USEFUL_MATERIAL_COUNT
+ LIGHTBANK_DAY,
+ LIGHTBANK_NIGHT
};
/*
- If true, the material allows light propagation and brightness is stored
- in param.
+ Simple rotation enum.
*/
-inline bool light_propagates_material(u8 m)
-{
- return (m == MATERIAL_AIR || m == MATERIAL_LIGHT || m == MATERIAL_WATER);
-}
+enum Rotation {
+ ROTATE_0,
+ ROTATE_90,
+ ROTATE_180,
+ ROTATE_270,
+ ROTATE_RAND,
+};
/*
- If true, the material allows lossless sunlight propagation.
-*/
-inline bool sunlight_propagates_material(u8 m)
-{
- return (m == MATERIAL_AIR);
-}
+ Masks for MapNode.param2 of flowing liquids
+ */
+#define LIQUID_LEVEL_MASK 0x07
+#define LIQUID_FLOW_DOWN_MASK 0x08
-/*
- On a node-node surface, the material of the node with higher solidness
- is used for drawing.
- 0: Invisible
- 1: Transparent
- 2: Opaque
-*/
-inline u8 material_solidness(u8 m)
-{
- if(m == MATERIAL_AIR)
- return 0;
- if(m == MATERIAL_WATER)
- return 1;
- return 2;
-}
-
-// Objects collide with walkable materials
-inline bool material_walkable(u8 m)
-{
- return (m != MATERIAL_AIR && m != MATERIAL_WATER);
-}
+//#define LIQUID_LEVEL_MASK 0x3f // better finite water
+//#define LIQUID_FLOW_DOWN_MASK 0x40 // not used when finite water
-// A liquid resists fast movement
-inline bool material_liquid(u8 m)
-{
- return (m == MATERIAL_WATER);
-}
+/* maximum amount of liquid in a block */
+#define LIQUID_LEVEL_MAX LIQUID_LEVEL_MASK
+#define LIQUID_LEVEL_SOURCE (LIQUID_LEVEL_MAX+1)
-// Pointable materials can be pointed to in the map
-inline bool material_pointable(u8 m)
-{
- return (m != MATERIAL_AIR && m != MATERIAL_WATER);
-}
+#define LIQUID_INFINITY_MASK 0x80 //0b10000000
-inline bool material_diggable(u8 m)
-{
- return (m != MATERIAL_AIR && m != MATERIAL_WATER);
-}
+// mask for leveled nodebox param2
+#define LEVELED_MASK 0x7F
+#define LEVELED_MAX LEVELED_MASK
-inline bool material_buildable_to(u8 m)
-{
- return (m == MATERIAL_AIR || m == MATERIAL_WATER);
-}
-/*
- Nodes make a face if materials differ and solidness differs.
- Return value:
- 0: No face
- 1: Face uses m1's material
- 2: Face uses m2's material
-*/
-inline u8 face_materials(u8 m1, u8 m2)
-{
- if(m1 == MATERIAL_IGNORE || m2 == MATERIAL_IGNORE)
- return 0;
-
- bool materials_differ = (m1 != m2);
- bool solidness_differs = (material_solidness(m1) != material_solidness(m2));
- bool makes_face = materials_differ && solidness_differs;
-
- if(makes_face == false)
- return 0;
-
- if(material_solidness(m1) > material_solidness(m2))
- return 1;
- else
- return 2;
-}
+struct ContentFeatures;
/*
- Returns true for materials that form the base ground that
- follows the main heightmap
+ This is the stuff what the whole world consists of.
*/
-inline bool is_ground_material(u8 m)
-{
- return(
- m == MATERIAL_STONE ||
- m == MATERIAL_GRASS ||
- m == MATERIAL_GRASS_FOOTSTEPS ||
- m == MATERIAL_MESE ||
- m == MATERIAL_MUD
- );
-}
+
struct MapNode
{
- //TODO: block type to differ from material
- // (e.g. grass edges or something)
- // block type
- u8 d;
+ /*
+ Main content
+ */
+ u16 param0;
/*
Misc parameter. Initialized to 0.
- For light_propagates() blocks, this is light intensity,
stored logarithmically from 0 to LIGHT_MAX.
Sunlight is LIGHT_SUN, which is LIGHT_MAX+1.
+ - Contains 2 values, day- and night lighting. Each takes 4 bits.
+ - Uhh... well, most blocks have light or nothing in here.
*/
- s8 param;
+ u8 param1;
- u8 pressure;
+ /*
+ The second parameter. Initialized to 0.
+ E.g. direction for torches and flowing water.
+ */
+ u8 param2;
- MapNode(const MapNode & n)
- {
- *this = n;
- }
-
- MapNode(u8 data=MATERIAL_AIR, u8 a_param=0)
- {
- d = data;
- param = a_param;
- }
+ MapNode() = default;
- bool operator==(const MapNode &other)
+ MapNode(content_t content, u8 a_param1=0, u8 a_param2=0) noexcept
+ : param0(content),
+ param1(a_param1),
+ param2(a_param2)
+ { }
+
+ bool operator==(const MapNode &other) const noexcept
{
- return (d == other.d && param == other.param);
+ return (param0 == other.param0
+ && param1 == other.param1
+ && param2 == other.param2);
}
- bool light_propagates()
+ // To be used everywhere
+ content_t getContent() const noexcept
{
- return light_propagates_material(d);
+ return param0;
}
-
- bool sunlight_propagates()
+ void setContent(content_t c) noexcept
{
- return sunlight_propagates_material(d);
+ param0 = c;
}
-
- u8 solidness()
+ u8 getParam1() const noexcept
{
- return material_solidness(d);
+ return param1;
}
-
- u8 light_source()
+ void setParam1(u8 p) noexcept
{
- /*
- Note that a block that isn't light_propagates() can be a light source.
- */
- if(d == MATERIAL_LIGHT)
- return LIGHT_MAX;
-
- return 0;
+ param1 = p;
}
-
- u8 getLight()
+ u8 getParam2() const noexcept
{
- // Select the brightest of [light_source, transparent_light]
- u8 light = 0;
- if(light_propagates())
- light = param & 0x0f;
- if(light_source() > light)
- light = light_source();
- return light;
+ return param2;
}
-
- void setLight(u8 a_light)
+ void setParam2(u8 p) noexcept
{
- // If not transparent, can't set light
- if(light_propagates() == false)
- return;
- param = a_light;
+ param2 = p;
}
- static u32 serializedLength(u8 version)
+ /*!
+ * Returns the color of the node.
+ *
+ * \param f content features of this node
+ * \param color output, contains the node's color.
+ */
+ void getColor(const ContentFeatures &f, video::SColor *color) const;
+
+ void setLight(LightBank bank, u8 a_light, const ContentFeatures &f) noexcept;
+
+ void setLight(LightBank bank, u8 a_light, const NodeDefManager *nodemgr);
+
+ /**
+ * Check if the light value for night differs from the light value for day.
+ *
+ * @return If the light values are equal, returns true; otherwise false
+ */
+ bool isLightDayNightEq(const NodeDefManager *nodemgr) const;
+
+ u8 getLight(LightBank bank, const NodeDefManager *nodemgr) const;
+
+ /*!
+ * Returns the node's light level from param1.
+ * If the node emits light, it is ignored.
+ * \param f the ContentFeatures of this node.
+ */
+ u8 getLightRaw(LightBank bank, const ContentFeatures &f) const noexcept;
+
+ /**
+ * This function differs from getLight(LightBank bank, NodeDefManager *nodemgr)
+ * in that the ContentFeatures of the node in question are not retrieved by
+ * the function itself. Thus, if you have already called nodemgr->get() to
+ * get the ContentFeatures you pass it to this function instead of the
+ * function getting ContentFeatures itself. Since NodeDefManager::get()
+ * is relatively expensive this can lead to significant performance
+ * improvements in some situations. Call this function if (and only if)
+ * you have already retrieved the ContentFeatures by calling
+ * NodeDefManager::get() for the node you're working with and the
+ * pre-conditions listed are true.
+ *
+ * @pre f != NULL
+ * @pre f->param_type == CPT_LIGHT
+ */
+ u8 getLightNoChecks(LightBank bank, const ContentFeatures *f) const noexcept;
+
+ bool getLightBanks(u8 &lightday, u8 &lightnight,
+ const NodeDefManager *nodemgr) const;
+
+ // 0 <= daylight_factor <= 1000
+ // 0 <= return value <= LIGHT_SUN
+ u8 getLightBlend(u32 daylight_factor, const NodeDefManager *nodemgr) const
{
- if(!ser_ver_supported(version))
- throw VersionMismatchException("ERROR: MapNode format not supported");
-
- if(version == 0)
- return 1;
- else
- return 2;
+ u8 lightday = 0;
+ u8 lightnight = 0;
+ getLightBanks(lightday, lightnight, nodemgr);
+ return blend_light(daylight_factor, lightday, lightnight);
}
- void serialize(u8 *dest, u8 version)
- {
- if(!ser_ver_supported(version))
- throw VersionMismatchException("ERROR: MapNode format not supported");
-
- if(version == 0)
- {
- dest[0] = d;
- }
- else
- {
- dest[0] = d;
- dest[1] = param;
- }
- }
- void deSerialize(u8 *source, u8 version)
- {
- if(!ser_ver_supported(version))
- throw VersionMismatchException("ERROR: MapNode format not supported");
-
- if(version == 0)
- {
- d = source[0];
- }
- else if(version == 1)
- {
- d = source[0];
- // This version doesn't support saved lighting
- if(light_propagates() || light_source() > 0)
- param = 0;
- else
- param = source[1];
- }
- else
- {
- d = source[0];
- param = source[1];
- }
- }
-};
-/*
- Returns integer position of the node in given
- floating point position.
-*/
-inline v3s16 floatToInt(v3f p)
-{
- v3s16 p2(
- (p.X + (p.X>0 ? BS/2 : -BS/2))/BS,
- (p.Y + (p.Y>0 ? BS/2 : -BS/2))/BS,
- (p.Z + (p.Z>0 ? BS/2 : -BS/2))/BS);
- return p2;
-}
-
-inline v3f intToFloat(v3s16 p)
-{
- v3f p2(
- p.X * BS,
- p.Y * BS,
- p.Z * BS
- );
- return p2;
-}
+ u8 getFaceDir(const NodeDefManager *nodemgr, bool allow_wallmounted = false) const;
+ u8 getWallMounted(const NodeDefManager *nodemgr) const;
+ v3s16 getWallMountedDir(const NodeDefManager *nodemgr) const;
+
+ /// @returns Rotation in range 0–239 (in 1.5° steps)
+ u8 getDegRotate(const NodeDefManager *nodemgr) const;
+
+ void rotateAlongYAxis(const NodeDefManager *nodemgr, Rotation rot);
+
+ /*!
+ * Checks which neighbors does this node connect to.
+ *
+ * \param p coordinates of the node
+ */
+ u8 getNeighbors(v3s16 p, Map *map) const;
+
+ /*
+ Gets list of node boxes (used for rendering (NDT_NODEBOX))
+ */
+ void getNodeBoxes(const NodeDefManager *nodemgr, std::vector<aabb3f> *boxes,
+ u8 neighbors = 0) const;
+
+ /*
+ Gets list of selection boxes
+ */
+ void getSelectionBoxes(const NodeDefManager *nodemg,
+ std::vector<aabb3f> *boxes, u8 neighbors = 0) const;
+ /*
+ Gets list of collision boxes
+ */
+ void getCollisionBoxes(const NodeDefManager *nodemgr,
+ std::vector<aabb3f> *boxes, u8 neighbors = 0) const;
+ /*
+ Liquid/leveled helpers
+ */
+ u8 getMaxLevel(const NodeDefManager *nodemgr) const;
+ u8 getLevel(const NodeDefManager *nodemgr) const;
+ s8 setLevel(const NodeDefManager *nodemgr, s16 level = 1);
+ s8 addLevel(const NodeDefManager *nodemgr, s16 add = 1);
-#endif
+ /*
+ Serialization functions
+ */
+ static u32 serializedLength(u8 version);
+ void serialize(u8 *dest, u8 version) const;
+ void deSerialize(u8 *source, u8 version);
+
+ // Serializes or deserializes a list of nodes in bulk format (first the
+ // content of all nodes, then the param1 of all nodes, then the param2
+ // of all nodes).
+ // version = serialization version. Must be >= 22
+ // content_width = the number of bytes of content per node
+ // params_width = the number of bytes of params per node
+ // compressed = true to zlib-compress output
+ static SharedBuffer<u8> serializeBulk(int version,
+ const MapNode *nodes, u32 nodecount,
+ u8 content_width, u8 params_width);
+ static void deSerializeBulk(std::istream &is, int version,
+ MapNode *nodes, u32 nodecount,
+ u8 content_width, u8 params_width);
+
+private:
+ // Deprecated serialization methods
+ void deSerialize_pre22(const u8 *source, u8 version);
+};
projects / dragonfireclient.git / blobdiff