3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef MAPNODE_HEADER
21 #define MAPNODE_HEADER
23 #include "irrlichttypes.h"
26 class INodeDefManager;
30 - Material = irrlicht's Material class
31 - Content = (content_t) content of a node
32 - Tile = TileSpec at some side of a node of some content type
35 0x000...0x07f: param2 is fully usable
36 0x800...0xfff: param2 lower 4 bytes are free
38 typedef u16 content_t;
39 #define MAX_CONTENT 0xfff
44 Anything that stores MapNodes doesn't have to preserve parameters
45 associated with this material.
47 Doesn't create faces with anything and is considered being
48 out-of-map in the game map.
50 #define CONTENT_IGNORE 127
51 #define CONTENT_IGNORE_DEFAULT_PARAM 0
54 The common material through which the player can walk and which
55 is transparent to light
57 #define CONTENT_AIR 126
61 Nodes make a face if contents differ and solidness differs.
64 1: Face uses m1's content
65 2: Face uses m2's content
66 equivalent: Whether the blocks share the same face (eg. water and glass)
68 u8 face_contents(content_t m1, content_t m2, bool *equivalent,
69 INodeDefManager *nodemgr);
73 Packs directions like (1,0,0), (1,-1,0) in six bits.
74 NOTE: This wastes way too much space for most purposes.
76 u8 packDir(v3s16 dir);
77 v3s16 unpackDir(u8 b);
80 facedir: CPT_FACEDIR_SIMPLE param1 value
81 dir: The face for which stuff is wanted
82 return value: The face from which the stuff is actually found
84 NOTE: Currently this uses 2 bits for Z-,X-,Z+,X+, should there be Y+
87 v3s16 facedir_rotate(u8 facedir, v3s16 dir);
96 Masks for MapNode.param2 of flowing liquids
98 #define LIQUID_LEVEL_MASK 0x07
99 #define LIQUID_FLOW_DOWN_MASK 0x08
101 /* maximum amount of liquid in a block */
102 #define LIQUID_LEVEL_MAX LIQUID_LEVEL_MASK
103 #define LIQUID_LEVEL_SOURCE (LIQUID_LEVEL_MAX+1)
106 This is the stuff what the whole world consists of.
114 0x00-0x7f: Short content type
115 0x80-0xff: Long content type (param2>>4 makes up low bytes)
120 Misc parameter. Initialized to 0.
121 - For light_propagates() blocks, this is light intensity,
122 stored logarithmically from 0 to LIGHT_MAX.
123 Sunlight is LIGHT_SUN, which is LIGHT_MAX+1.
124 - Contains 2 values, day- and night lighting. Each takes 4 bits.
125 - Mineral content (should be removed from here)
126 - Uhh... well, most blocks have light or nothing in here.
131 The second parameter. Initialized to 0.
132 E.g. direction for torches and flowing water.
133 If param0 >= 0x80, bits 0xf0 of this is extended content type data
137 MapNode(const MapNode & n)
142 MapNode(content_t content=CONTENT_AIR, u8 a_param1=0, u8 a_param2=0)
146 // Set content (param0 and (param2&0xf0)) after other params
147 // because this needs to override part of param2
151 // Create directly from a nodename
152 // If name is unknown, sets CONTENT_IGNORE
153 MapNode(INodeDefManager *ndef, const std::string &name,
154 u8 a_param1=0, u8 a_param2=0);
156 bool operator==(const MapNode &other)
158 return (param0 == other.param0
159 && param1 == other.param1
160 && param2 == other.param2);
163 // To be used everywhere
164 content_t getContent() const
169 return (param0<<4) + (param2>>4);
171 void setContent(content_t c)
183 param2 |= (c&0x0f)<<4;
199 return param2 & 0x0f;
211 void setLight(enum LightBank bank, u8 a_light, INodeDefManager *nodemgr);
212 u8 getLight(enum LightBank bank, INodeDefManager *nodemgr) const;
213 u8 getLightBanksWithSource(INodeDefManager *nodemgr) const;
215 // 0 <= daylight_factor <= 1000
216 // 0 <= return value <= LIGHT_SUN
217 u8 getLightBlend(u32 daylight_factor, INodeDefManager *nodemgr) const
219 u8 l = ((daylight_factor * getLight(LIGHTBANK_DAY, nodemgr)
220 + (1000-daylight_factor) * getLight(LIGHTBANK_NIGHT, nodemgr))
223 if(getLight(LIGHTBANK_DAY, nodemgr) == LIGHT_SUN)
229 /*// 0 <= daylight_factor <= 1000
230 // 0 <= return value <= 255
231 u8 getLightBlend(u32 daylight_factor, INodeDefManager *nodemgr)
233 u8 daylight = decode_light(getLight(LIGHTBANK_DAY, nodemgr));
234 u8 nightlight = decode_light(getLight(LIGHTBANK_NIGHT, nodemgr));
235 u8 mix = ((daylight_factor * daylight
236 + (1000-daylight_factor) * nightlight)
242 Gets mineral content of node, if there is any.
243 MINERAL_NONE if doesn't contain or isn't able to contain mineral.
245 u8 getMineral(INodeDefManager *nodemgr) const;
248 Serialization functions
251 static u32 serializedLength(u8 version);
252 void serialize(u8 *dest, u8 version);
253 void deSerialize(u8 *source, u8 version);
258 Gets lighting value at face of node
260 Parameters must consist of air and !air.
261 Order doesn't matter.
263 If either of the nodes doesn't exist, light is 0.
266 daynight_ratio: 0...1000
267 n: getNode(p) (uses only the lighting value)
268 n2: getNode(p + face_dir) (uses only the lighting value)
269 face_dir: axis oriented unit vector from p to p2
271 returns encoded light value.
273 u8 getFaceLight(u32 daynight_ratio, MapNode n, MapNode n2,
274 v3s16 face_dir, INodeDefManager *nodemgr);