minetest/src/mapnode.h

451 lines
8.2 KiB
C
Raw Normal View History

2010-11-27 00:02:21 +01:00
/*
2010-11-29 19:05:30 +01:00
Minetest-c55
Copyright (C) 2010 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
(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.
You should have received a copy of the GNU 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.
2010-11-27 00:02:21 +01:00
*/
#ifndef MAPNODE_HEADER
#define MAPNODE_HEADER
#include <iostream>
#include "common_irrlicht.h"
#include "light.h"
#include "utility.h"
#include "exceptions.h"
#include "serialization.h"
// Size of node in rendering units
#define BS 10
#define MATERIALS_COUNT 256
/*
Ignored node.
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.
*/
2010-12-13 02:19:12 +01:00
#define CONTENT_IGNORE 255
#define CONTENT_IGNORE_DEFAULT_PARAM 0
/*
The common material through which the player can walk and which
is transparent to light
*/
2010-12-13 02:19:12 +01:00
#define CONTENT_AIR 254
2010-11-27 00:02:21 +01:00
/*
2010-12-13 02:19:12 +01:00
Suggested materials:
2010-11-27 00:02:21 +01:00
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?
2010-12-13 02:19:12 +01:00
New naming scheme:
- Material = irrlicht's Material class
- Content = (u8) content of a node
- Tile = (u16) Material ID at some side of a node
2010-11-27 00:02:21 +01:00
*/
2010-12-13 02:19:12 +01:00
enum Content
2010-11-27 00:02:21 +01:00
{
2010-12-13 02:19:12 +01:00
CONTENT_STONE=0,
2010-11-27 00:02:21 +01:00
2010-12-13 20:32:35 +01:00
CONTENT_GRASS=1,
2010-11-27 00:02:21 +01:00
2010-12-13 20:32:35 +01:00
CONTENT_WATER=2,
2010-11-27 00:02:21 +01:00
2010-12-13 20:32:35 +01:00
CONTENT_LIGHT=3,
2010-11-27 00:02:21 +01:00
2010-12-13 20:32:35 +01:00
CONTENT_TREE=4,
2010-12-01 14:20:12 +01:00
2010-12-13 20:32:35 +01:00
CONTENT_LEAVES=5,
2010-11-27 00:02:21 +01:00
2010-12-13 20:32:35 +01:00
CONTENT_GRASS_FOOTSTEPS=6,
2010-11-27 00:02:21 +01:00
2010-12-13 20:32:35 +01:00
CONTENT_MESE=7,
2010-12-13 20:32:35 +01:00
CONTENT_MUD=8,
2010-12-13 20:32:35 +01:00
CONTENT_OCEAN=9,
2010-11-27 00:02:21 +01:00
// This is set to the number of the actual values in this enum
2010-12-13 02:19:12 +01:00
USEFUL_CONTENT_COUNT
2010-11-27 00:02:21 +01:00
};
/*
If true, the material allows light propagation and brightness is stored
in param.
*/
2010-12-13 02:19:12 +01:00
inline bool light_propagates_content(u8 m)
2010-11-27 00:02:21 +01:00
{
2010-12-13 02:19:12 +01:00
return (m == CONTENT_AIR || m == CONTENT_LIGHT || m == CONTENT_WATER || m == CONTENT_OCEAN);
2010-11-27 00:02:21 +01:00
}
/*
If true, the material allows lossless sunlight propagation.
*/
2010-12-13 02:19:12 +01:00
inline bool sunlight_propagates_content(u8 m)
2010-11-27 00:02:21 +01:00
{
2010-12-13 02:19:12 +01:00
return (m == CONTENT_AIR || m == CONTENT_LIGHT);
2010-11-27 00:02:21 +01:00
}
/*
On a node-node surface, the material of the node with higher solidness
is used for drawing.
0: Invisible
1: Transparent
2: Opaque
*/
2010-12-13 02:19:12 +01:00
inline u8 content_solidness(u8 m)
2010-11-27 00:02:21 +01:00
{
2010-12-13 02:19:12 +01:00
if(m == CONTENT_AIR)
2010-11-27 00:02:21 +01:00
return 0;
2010-12-13 02:19:12 +01:00
if(m == CONTENT_WATER || m == CONTENT_OCEAN)
2010-11-27 00:02:21 +01:00
return 1;
return 2;
}
2010-12-13 02:19:12 +01:00
// Objects collide with walkable contents
inline bool content_walkable(u8 m)
2010-11-30 14:35:03 +01:00
{
2010-12-13 02:19:12 +01:00
return (m != CONTENT_AIR && m != CONTENT_WATER && m != CONTENT_OCEAN && m != CONTENT_LIGHT);
2010-11-30 14:35:03 +01:00
}
// A liquid resists fast movement
2010-12-13 02:19:12 +01:00
inline bool content_liquid(u8 m)
2010-11-30 14:35:03 +01:00
{
2010-12-13 02:19:12 +01:00
return (m == CONTENT_WATER || m == CONTENT_OCEAN);
2010-11-30 14:35:03 +01:00
}
2010-12-13 02:19:12 +01:00
// Pointable contents can be pointed to in the map
inline bool content_pointable(u8 m)
2010-11-30 14:35:03 +01:00
{
2010-12-13 02:19:12 +01:00
return (m != CONTENT_AIR && m != CONTENT_WATER && m != CONTENT_OCEAN);
2010-11-30 14:35:03 +01:00
}
2010-12-13 02:19:12 +01:00
inline bool content_diggable(u8 m)
2010-11-30 14:35:03 +01:00
{
2010-12-13 02:19:12 +01:00
return (m != CONTENT_AIR && m != CONTENT_WATER && m != CONTENT_OCEAN);
2010-11-30 14:35:03 +01:00
}
2010-12-13 02:19:12 +01:00
inline bool content_buildable_to(u8 m)
2010-11-30 14:35:03 +01:00
{
2010-12-13 02:19:12 +01:00
return (m == CONTENT_AIR || m == CONTENT_WATER || m == CONTENT_OCEAN);
}
/*
2010-12-13 02:19:12 +01:00
TODO: Make a mapper class for mapping every side of a content
to some tile.
This dumbily maps all sides of content to the tile of the same id.
*/
2010-12-13 02:19:12 +01:00
inline u8 content_tile(u8 c)
{
2010-12-13 02:19:12 +01:00
if(c == CONTENT_IGNORE || c == CONTENT_LIGHT)
return CONTENT_AIR;
return c;
}
/*
2010-12-13 02:19:12 +01:00
Returns true for contents that form the base ground that
follows the main heightmap
*/
2010-12-13 02:19:12 +01:00
inline bool is_ground_content(u8 m)
{
return(
2010-12-13 02:19:12 +01:00
m == CONTENT_STONE ||
m == CONTENT_GRASS ||
m == CONTENT_GRASS_FOOTSTEPS ||
m == CONTENT_MESE ||
m == CONTENT_MUD
);
2010-11-30 14:35:03 +01:00
}
2010-11-27 00:02:21 +01:00
/*
2010-12-13 02:19:12 +01:00
Nodes make a face if contents differ and solidness differs.
2010-11-27 00:02:21 +01:00
Return value:
0: No face
2010-12-13 02:19:12 +01:00
1: Face uses m1's content
2: Face uses m2's content
2010-11-27 00:02:21 +01:00
*/
2010-12-13 02:19:12 +01:00
inline u8 face_contents(u8 m1, u8 m2)
2010-11-27 00:02:21 +01:00
{
2010-12-13 02:19:12 +01:00
if(m1 == CONTENT_IGNORE || m2 == CONTENT_IGNORE)
2010-11-27 00:02:21 +01:00
return 0;
2010-12-13 02:19:12 +01:00
bool contents_differ = (m1 != m2);
bool solidness_differs = (content_solidness(m1) != content_solidness(m2));
bool makes_face = contents_differ && solidness_differs;
2010-11-27 00:02:21 +01:00
if(makes_face == false)
return 0;
2010-12-13 02:19:12 +01:00
if(content_solidness(m1) > content_solidness(m2))
2010-11-27 00:02:21 +01:00
return 1;
else
return 2;
}
2010-12-13 02:19:12 +01:00
inline bool liquid_replaces_content(u8 c)
{
return (c == CONTENT_AIR || c == CONTENT_LIGHT);
}
/*
When placing a node, drection info is added to it if this is true
*/
inline bool content_directional(u8 c)
{
return (c == CONTENT_LIGHT);
}
/*
Packs directions like (1,0,0), (1,-1,0)
*/
inline u8 packDir(v3s16 dir)
{
u8 b = 0;
if(dir.X > 0)
b |= (1<<0);
else if(dir.X < 0)
b |= (1<<1);
if(dir.Y > 0)
b |= (1<<2);
else if(dir.Y < 0)
b |= (1<<3);
if(dir.Z > 0)
b |= (1<<4);
else if(dir.Z < 0)
b |= (1<<5);
return b;
}
inline v3s16 unpackDir(u8 b)
{
v3s16 d(0,0,0);
if(b & (1<<0))
d.X = 1;
else if(b & (1<<1))
d.X = -1;
if(b & (1<<2))
d.Y = 1;
else if(b & (1<<3))
d.Y = -1;
if(b & (1<<4))
d.Z = 1;
else if(b & (1<<5))
d.Z = -1;
return d;
}
2010-11-27 00:02:21 +01:00
struct MapNode
{
2010-12-13 02:19:12 +01:00
// Content
2010-11-27 00:02:21 +01:00
u8 d;
/*
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.
*/
s8 param;
2010-12-13 02:19:12 +01:00
union
{
/*
Pressure for liquids
*/
u8 pressure;
2010-11-27 00:02:21 +01:00
2010-12-13 02:19:12 +01:00
/*
Direction for torches and other stuff.
If possible, packed with packDir.
*/
u8 dir;
};
2010-12-01 14:20:12 +01:00
2010-11-27 00:02:21 +01:00
MapNode(const MapNode & n)
{
*this = n;
}
2010-12-13 02:19:12 +01:00
MapNode(u8 data=CONTENT_AIR, u8 a_param=0, u8 a_pressure=0)
2010-11-27 00:02:21 +01:00
{
d = data;
param = a_param;
pressure = a_pressure;
2010-11-27 00:02:21 +01:00
}
bool operator==(const MapNode &other)
{
return (d == other.d
&& param == other.param
&& pressure == other.pressure);
}
2010-11-27 00:02:21 +01:00
bool light_propagates()
{
2010-12-13 02:19:12 +01:00
return light_propagates_content(d);
2010-11-27 00:02:21 +01:00
}
bool sunlight_propagates()
{
2010-12-13 02:19:12 +01:00
return sunlight_propagates_content(d);
2010-11-27 00:02:21 +01:00
}
u8 solidness()
{
2010-12-13 02:19:12 +01:00
return content_solidness(d);
2010-11-27 00:02:21 +01:00
}
u8 light_source()
{
/*
Note that a block that isn't light_propagates() can be a light source.
*/
2010-12-13 02:19:12 +01:00
if(d == CONTENT_LIGHT)
2010-11-27 00:02:21 +01:00
return LIGHT_MAX;
return 0;
}
u8 getLight()
{
2010-12-13 02:19:12 +01:00
// Select the brightest of [light source, propagated light]
2010-11-27 00:02:21 +01:00
u8 light = 0;
if(light_propagates())
light = param & 0x0f;
if(light_source() > light)
light = light_source();
return light;
}
void setLight(u8 a_light)
{
// If not transparent, can't set light
if(light_propagates() == false)
return;
param = a_light;
}
/*
These serialization functions are used when informing client
of a single node add
*/
2010-11-27 00:02:21 +01:00
static u32 serializedLength(u8 version)
{
if(!ser_ver_supported(version))
throw VersionMismatchException("ERROR: MapNode format not supported");
if(version == 0)
return 1;
else if(version <= 9)
2010-11-27 00:02:21 +01:00
return 2;
else
return 3;
2010-11-27 00:02:21 +01:00
}
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 if(version <= 9)
{
dest[0] = d;
dest[1] = param;
}
2010-11-27 00:02:21 +01:00
else
{
dest[0] = d;
dest[1] = param;
dest[2] = pressure;
2010-11-27 00:02:21 +01:00
}
}
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 if(version <= 9)
{
d = source[0];
param = source[1];
}
2010-11-27 00:02:21 +01:00
else
{
d = source[0];
param = source[1];
pressure = source[2];
2010-11-27 00:02:21 +01:00
}
}
};
/*
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;
}
#endif