3 Copyright (C) 2010-2013 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 Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser 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.
22 #include "irrlichttypes_bloated.h"
32 - Material = irrlicht's Material class
33 - Content = (content_t) content of a node
34 - Tile = TileSpec at some side of a node of some content type
36 typedef u16 content_t;
39 The maximum node ID that can be registered by mods. This must
40 be significantly lower than the maximum content_t value, so that
41 there is enough room for dummy node IDs, which are created when
42 a MapBlock containing unknown node names is loaded from disk.
44 #define MAX_REGISTERED_CONTENT 0x7fffU
47 A solid walkable node with the texture unknown_node.png.
49 For example, used on the client to display unregistered node IDs
50 (instead of expanding the vector of node definitions each time
51 such a node is received).
53 #define CONTENT_UNKNOWN 125
56 The common material through which the player can walk and which
57 is transparent to light
59 #define CONTENT_AIR 126
64 Unloaded chunks are considered to consist of this. Several other
65 methods return this when an error occurs. Also, during
66 map generation this means the node has not been set yet.
68 Doesn't create faces with anything and is considered being
69 out-of-map in the game map.
71 #define CONTENT_IGNORE 127
91 Masks for MapNode.param2 of flowing liquids
93 #define LIQUID_LEVEL_MASK 0x07
94 #define LIQUID_FLOW_DOWN_MASK 0x08
96 //#define LIQUID_LEVEL_MASK 0x3f // better finite water
97 //#define LIQUID_FLOW_DOWN_MASK 0x40 // not used when finite water
99 /* maximum amount of liquid in a block */
100 #define LIQUID_LEVEL_MAX LIQUID_LEVEL_MASK
101 #define LIQUID_LEVEL_SOURCE (LIQUID_LEVEL_MAX+1)
103 #define LIQUID_INFINITY_MASK 0x80 //0b10000000
105 // mask for leveled nodebox param2
106 #define LEVELED_MASK 0x7F
107 #define LEVELED_MAX LEVELED_MASK
110 struct ContentFeatures;
113 This is the stuff what the whole world consists of.
125 Misc parameter. Initialized to 0.
126 - For light_propagates() blocks, this is light intensity,
127 stored logarithmically from 0 to LIGHT_MAX.
128 Sunlight is LIGHT_SUN, which is LIGHT_MAX+1.
129 - Contains 2 values, day- and night lighting. Each takes 4 bits.
130 - Uhh... well, most blocks have light or nothing in here.
135 The second parameter. Initialized to 0.
136 E.g. direction for torches and flowing water.
142 MapNode(content_t content, u8 a_param1=0, u8 a_param2=0) noexcept
148 // Create directly from a nodename
149 // If name is unknown, sets CONTENT_IGNORE
150 MapNode(const NodeDefManager *ndef, const std::string &name,
151 u8 a_param1=0, u8 a_param2=0);
153 bool operator==(const MapNode &other) const noexcept
155 return (param0 == other.param0
156 && param1 == other.param1
157 && param2 == other.param2);
160 // To be used everywhere
161 content_t getContent() const noexcept
165 void setContent(content_t c) noexcept
169 u8 getParam1() const noexcept
173 void setParam1(u8 p) noexcept
177 u8 getParam2() const noexcept
181 void setParam2(u8 p) noexcept
187 * Returns the color of the node.
189 * \param f content features of this node
190 * \param color output, contains the node's color.
192 void getColor(const ContentFeatures &f, video::SColor *color) const;
194 void setLight(LightBank bank, u8 a_light, const ContentFeatures &f) noexcept;
196 void setLight(LightBank bank, u8 a_light, const NodeDefManager *nodemgr);
199 * Check if the light value for night differs from the light value for day.
201 * @return If the light values are equal, returns true; otherwise false
203 bool isLightDayNightEq(const NodeDefManager *nodemgr) const;
205 u8 getLight(LightBank bank, const NodeDefManager *nodemgr) const;
208 * Returns the node's light level from param1.
209 * If the node emits light, it is ignored.
210 * \param f the ContentFeatures of this node.
212 u8 getLightRaw(LightBank bank, const ContentFeatures &f) const noexcept;
215 * This function differs from getLight(LightBank bank, NodeDefManager *nodemgr)
216 * in that the ContentFeatures of the node in question are not retrieved by
217 * the function itself. Thus, if you have already called nodemgr->get() to
218 * get the ContentFeatures you pass it to this function instead of the
219 * function getting ContentFeatures itself. Since NodeDefManager::get()
220 * is relatively expensive this can lead to significant performance
221 * improvements in some situations. Call this function if (and only if)
222 * you have already retrieved the ContentFeatures by calling
223 * NodeDefManager::get() for the node you're working with and the
224 * pre-conditions listed are true.
227 * @pre f->param_type == CPT_LIGHT
229 u8 getLightNoChecks(LightBank bank, const ContentFeatures *f) const noexcept;
231 bool getLightBanks(u8 &lightday, u8 &lightnight,
232 const NodeDefManager *nodemgr) const;
234 // 0 <= daylight_factor <= 1000
235 // 0 <= return value <= LIGHT_SUN
236 u8 getLightBlend(u32 daylight_factor, const NodeDefManager *nodemgr) const
240 getLightBanks(lightday, lightnight, nodemgr);
241 return blend_light(daylight_factor, lightday, lightnight);
244 u8 getFaceDir(const NodeDefManager *nodemgr, bool allow_wallmounted = false) const;
245 u8 getWallMounted(const NodeDefManager *nodemgr) const;
246 v3s16 getWallMountedDir(const NodeDefManager *nodemgr) const;
248 void rotateAlongYAxis(const NodeDefManager *nodemgr, Rotation rot);
251 * Checks which neighbors does this node connect to.
253 * \param p coordinates of the node
255 u8 getNeighbors(v3s16 p, Map *map) const;
258 Gets list of node boxes (used for rendering (NDT_NODEBOX))
260 void getNodeBoxes(const NodeDefManager *nodemgr, std::vector<aabb3f> *boxes,
261 u8 neighbors = 0) const;
264 Gets list of selection boxes
266 void getSelectionBoxes(const NodeDefManager *nodemg,
267 std::vector<aabb3f> *boxes, u8 neighbors = 0) const;
270 Gets list of collision boxes
272 void getCollisionBoxes(const NodeDefManager *nodemgr,
273 std::vector<aabb3f> *boxes, u8 neighbors = 0) const;
278 u8 getMaxLevel(const NodeDefManager *nodemgr) const;
279 u8 getLevel(const NodeDefManager *nodemgr) const;
280 u8 setLevel(const NodeDefManager *nodemgr, s8 level = 1);
281 u8 addLevel(const NodeDefManager *nodemgr, s8 add = 1);
284 Serialization functions
287 static u32 serializedLength(u8 version);
288 void serialize(u8 *dest, u8 version) const;
289 void deSerialize(u8 *source, u8 version);
291 // Serializes or deserializes a list of nodes in bulk format (first the
292 // content of all nodes, then the param1 of all nodes, then the param2
294 // version = serialization version. Must be >= 22
295 // content_width = the number of bytes of content per node
296 // params_width = the number of bytes of params per node
297 // compressed = true to zlib-compress output
298 static void serializeBulk(std::ostream &os, int version,
299 const MapNode *nodes, u32 nodecount,
300 u8 content_width, u8 params_width, bool compressed);
301 static void deSerializeBulk(std::istream &is, int version,
302 MapNode *nodes, u32 nodecount,
303 u8 content_width, u8 params_width, bool compressed);
306 // Deprecated serialization methods
307 void deSerialize_pre22(const u8 *source, u8 version);