minetest/src/mapnode.h

305 lines
8.1 KiB
C
Raw Normal View History

2010-11-27 00:02:21 +01:00
/*
2013-02-24 18:40:43 +01:00
Minetest
2013-02-24 19:38:45 +01:00
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
2010-11-29 19:05:30 +01:00
This program is free software; you can redistribute it and/or modify
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
2010-11-29 19:05:30 +01:00
(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 Lesser General Public License for more details.
2010-11-29 19:05:30 +01:00
You should have received a copy of the GNU Lesser General Public License along
2010-11-29 19:05:30 +01:00
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
2010-11-27 00:02:21 +01:00
*/
#pragma once
2010-11-27 00:02:21 +01:00
#include "irrlichttypes_bloated.h"
2010-11-27 00:02:21 +01:00
#include "light.h"
#include <string>
#include <vector>
2011-11-14 20:41:30 +01:00
class INodeDefManager;
class Map;
2011-11-14 20:41:30 +01:00
/*
Naming scheme:
- Material = irrlicht's Material class
2011-07-23 15:55:26 +02:00
- Content = (content_t) content of a node
- Tile = TileSpec at some side of a node of some content type
*/
typedef u16 content_t;
/*
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
/*
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 CONTENT_UNKNOWN 125
/*
The common material through which the player can walk and which
is transparent to light
*/
#define CONTENT_AIR 126
2010-11-27 00:02:21 +01:00
/*
Ignored node.
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
2010-12-18 16:46:00 +01:00
enum LightBank
{
LIGHTBANK_DAY,
LIGHTBANK_NIGHT
};
/*
Simple rotation enum.
*/
enum Rotation {
ROTATE_0,
ROTATE_90,
ROTATE_180,
ROTATE_270,
ROTATE_RAND,
};
/*
Masks for MapNode.param2 of flowing liquids
*/
#define LIQUID_LEVEL_MASK 0x07
#define LIQUID_FLOW_DOWN_MASK 0x08
2013-02-24 15:39:07 +01:00
//#define LIQUID_LEVEL_MASK 0x3f // better finite water
//#define LIQUID_FLOW_DOWN_MASK 0x40 // not used when finite water
2011-08-16 08:31:33 +02:00
/* maximum amount of liquid in a block */
#define LIQUID_LEVEL_MAX LIQUID_LEVEL_MASK
#define LIQUID_LEVEL_SOURCE (LIQUID_LEVEL_MAX+1)
2013-02-24 15:39:07 +01:00
#define LIQUID_INFINITY_MASK 0x80 //0b10000000
// mask for leveled nodebox param2
#define LEVELED_MASK 0x7F
2013-07-13 19:48:14 +02:00
#define LEVELED_MAX LEVELED_MASK
struct ContentFeatures;
/*
This is the stuff what the whole world consists of.
*/
2010-11-27 00:02:21 +01:00
struct MapNode
{
/*
Main content
*/
u16 param0;
2010-11-27 00:02:21 +01:00
/*
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.
2010-11-27 00:02:21 +01:00
*/
u8 param1;
2011-04-04 10:18:14 +02:00
/*
The second parameter. Initialized to 0.
E.g. direction for torches and flowing water.
*/
u8 param2;
2010-12-01 14:20:12 +01:00
MapNode() = default;
MapNode(content_t content, u8 a_param1=0, u8 a_param2=0)
2014-12-21 16:37:45 +01:00
: param0(content),
param1(a_param1),
param2(a_param2)
{ }
2011-11-16 15:47:20 +01:00
// Create directly from a nodename
// If name is unknown, sets CONTENT_IGNORE
MapNode(INodeDefManager *ndef, const std::string &name,
u8 a_param1=0, u8 a_param2=0);
2010-11-27 00:02:21 +01:00
bool operator==(const MapNode &other)
{
2011-07-23 15:55:26 +02:00
return (param0 == other.param0
&& param1 == other.param1
&& param2 == other.param2);
}
// To be used everywhere
2011-11-14 20:41:30 +01:00
content_t getContent() const
{
return param0;
}
void setContent(content_t c)
{
param0 = c;
}
2011-11-17 10:22:24 +01:00
u8 getParam1() const
{
return param1;
}
void setParam1(u8 p)
{
param1 = p;
}
u8 getParam2() const
{
return param2;
2011-11-17 10:22:24 +01:00
}
void setParam2(u8 p)
{
param2 = p;
2011-11-17 10:22:24 +01:00
}
/*!
* 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(enum LightBank bank, u8 a_light, const ContentFeatures &f);
2011-11-14 20:41:30 +01:00
void setLight(enum LightBank bank, u8 a_light, INodeDefManager *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(INodeDefManager *nodemgr) const;
2011-11-14 20:41:30 +01:00
u8 getLight(enum LightBank bank, INodeDefManager *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(enum LightBank bank, const ContentFeatures &f) const;
/**
* This function differs from getLight(enum LightBank bank, INodeDefManager *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 INodeDefManager::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
* INodeDefManager::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;
bool getLightBanks(u8 &lightday, u8 &lightnight, INodeDefManager *nodemgr) const;
2014-12-14 12:28:08 +01:00
2010-12-18 16:46:00 +01:00
// 0 <= daylight_factor <= 1000
2010-12-21 17:08:24 +01:00
// 0 <= return value <= LIGHT_SUN
2011-11-14 20:41:30 +01:00
u8 getLightBlend(u32 daylight_factor, INodeDefManager *nodemgr) const
2010-12-18 16:46:00 +01:00
{
u8 lightday = 0;
u8 lightnight = 0;
getLightBanks(lightday, lightnight, nodemgr);
return blend_light(daylight_factor, lightday, lightnight);
2010-12-18 16:46:00 +01:00
}
2010-11-27 00:02:21 +01:00
u8 getFaceDir(INodeDefManager *nodemgr, bool allow_wallmounted = false) const;
u8 getWallMounted(INodeDefManager *nodemgr) const;
v3s16 getWallMountedDir(INodeDefManager *nodemgr) const;
void rotateAlongYAxis(INodeDefManager *nodemgr, Rotation rot);
/*!
* Checks which neighbors does this node connect to.
*
* \param p coordinates of the node
*/
u8 getNeighbors(v3s16 p, Map *map);
/*
2014-10-18 18:46:16 +02:00
Gets list of node boxes (used for rendering (NDT_NODEBOX))
*/
Nodebox: Allow nodeboxes to "connect" We introduce a new nodebox type "connected", and allow these nodes to have optional nodeboxes that connect it to other connecting nodeboxes. This is all done at scenedraw time in the client. The client will inspect the surrounding nodes and if they are to be connected to, it will draw the appropriate connecting nodeboxes to make those connections. In the node_box definition, we have to specify separate nodeboxes for each valid connection. This allows us to make nodes that connect only horizontally (the common case) by providing optional nodeboxes for +x, -x, +z, -z directions. Or this allows us to make wires that can connect up and down, by providing nodeboxes that connect it up and down (+y, -y) as well. The optional nodeboxes can be arrays. They are named "connect_top, "connect_bottom", "connect_front", "connect_left", "connect_back" and "connect_right". Here, "front" means the south facing side of the node that has facedir = 0. Additionally, a "fixed" nodebox list present will always be drawn, so one can make a central post, for instance. This "fixed" nodebox can be omitted, or it can be an array of nodeboxes. Collision boxes are also updated in exactly the same fashion, which allows you to walk over the upper extremities of the individual node boxes, or stand really close to them. You can also walk up node noxes that are small in height, all as expected, and unlike the NDT_FENCELIKE nodes. I've posted a screenshot demonstrating the flexibility at http://i.imgur.com/zaJq8jo.png In the screenshot, all connecting nodes are of this new subtype. Transparent textures render incorrectly, Which I don't think is related to this text, as other nodeboxes also have issues with this. A protocol bump is performed in order to be able to send older clients a nodeblock that is usable for them. In order to avoid abuse of users we send older clients a "full-size" node, so that it's impossible for them to try and walk through a fence or wall that's created in this fashion. This was tested with a pre-bump client connected against a server running the new protocol. These nodes connect to other nodes, and you can select which ones those are by specifying node names (or group names) in the connects_to string array: connects_to = { "group:fence", "default:wood" } By default, nodes do not connect to anything, allowing you to create nodes that always have to be paired in order to connect. lua_api.txt is updated to reflect the extension to the node_box API. Example lua code needed to generate these nodes can be found here: https://gist.github.com/sofar/b381c8c192c8e53e6062
2016-02-25 09:16:31 +01:00
void getNodeBoxes(INodeDefManager *nodemgr, std::vector<aabb3f> *boxes, u8 neighbors = 0);
/*
Gets list of selection boxes
*/
void getSelectionBoxes(INodeDefManager *nodemg, std::vector<aabb3f> *boxes, u8 neighbors = 0);
2014-10-18 18:46:16 +02:00
/*
Gets list of collision boxes
*/
Nodebox: Allow nodeboxes to "connect" We introduce a new nodebox type "connected", and allow these nodes to have optional nodeboxes that connect it to other connecting nodeboxes. This is all done at scenedraw time in the client. The client will inspect the surrounding nodes and if they are to be connected to, it will draw the appropriate connecting nodeboxes to make those connections. In the node_box definition, we have to specify separate nodeboxes for each valid connection. This allows us to make nodes that connect only horizontally (the common case) by providing optional nodeboxes for +x, -x, +z, -z directions. Or this allows us to make wires that can connect up and down, by providing nodeboxes that connect it up and down (+y, -y) as well. The optional nodeboxes can be arrays. They are named "connect_top, "connect_bottom", "connect_front", "connect_left", "connect_back" and "connect_right". Here, "front" means the south facing side of the node that has facedir = 0. Additionally, a "fixed" nodebox list present will always be drawn, so one can make a central post, for instance. This "fixed" nodebox can be omitted, or it can be an array of nodeboxes. Collision boxes are also updated in exactly the same fashion, which allows you to walk over the upper extremities of the individual node boxes, or stand really close to them. You can also walk up node noxes that are small in height, all as expected, and unlike the NDT_FENCELIKE nodes. I've posted a screenshot demonstrating the flexibility at http://i.imgur.com/zaJq8jo.png In the screenshot, all connecting nodes are of this new subtype. Transparent textures render incorrectly, Which I don't think is related to this text, as other nodeboxes also have issues with this. A protocol bump is performed in order to be able to send older clients a nodeblock that is usable for them. In order to avoid abuse of users we send older clients a "full-size" node, so that it's impossible for them to try and walk through a fence or wall that's created in this fashion. This was tested with a pre-bump client connected against a server running the new protocol. These nodes connect to other nodes, and you can select which ones those are by specifying node names (or group names) in the connects_to string array: connects_to = { "group:fence", "default:wood" } By default, nodes do not connect to anything, allowing you to create nodes that always have to be paired in order to connect. lua_api.txt is updated to reflect the extension to the node_box API. Example lua code needed to generate these nodes can be found here: https://gist.github.com/sofar/b381c8c192c8e53e6062
2016-02-25 09:16:31 +01:00
void getCollisionBoxes(INodeDefManager *nodemgr, std::vector<aabb3f> *boxes, u8 neighbors = 0);
2014-10-18 18:46:16 +02:00
/*
Liquid helpers
*/
2013-07-27 20:34:30 +02:00
u8 getMaxLevel(INodeDefManager *nodemgr) const;
2013-07-13 19:48:14 +02:00
u8 getLevel(INodeDefManager *nodemgr) const;
u8 setLevel(INodeDefManager *nodemgr, s8 level = 1);
2013-07-27 20:34:30 +02:00
u8 addLevel(INodeDefManager *nodemgr, s8 add = 1);
2013-07-13 19:48:14 +02:00
/*
Serialization functions
*/
static u32 serializedLength(u8 version);
void serialize(u8 *dest, u8 version);
2011-11-16 12:03:28 +01:00
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 void serializeBulk(std::ostream &os, int version,
const MapNode *nodes, u32 nodecount,
u8 content_width, u8 params_width, bool compressed);
static void deSerializeBulk(std::istream &is, int version,
MapNode *nodes, u32 nodecount,
u8 content_width, u8 params_width, bool compressed);
private:
// Deprecated serialization methods
void deSerialize_pre22(const u8 *source, u8 version);
2010-11-27 00:02:21 +01:00
};