src/mapnode.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #ifndef MAPNODE_HEADER
  21 #define MAPNODE_HEADER
  22
  23 #include "irrlichttypes.h"
  24 #include "irr_v3d.h"
  25 #include "irr_aabb3d.h"
  26 #include "light.h"
  27 #include <string>
  28 #include <vector>
  29
  30 class INodeDefManager;
  31
  32 /*
  33         Naming scheme:
  34         - Material = irrlicht's Material class
  35         - Content = (content_t) content of a node
  36         - Tile = TileSpec at some side of a node of some content type
  37 */
  38 typedef u16 content_t;
  39
  40 /*
  41         The maximum node ID that can be registered by mods. This must
  42         be significantly lower than the maximum content_t value, so that
  43         there is enough room for dummy node IDs, which are created when
  44         a MapBlock containing unknown node names is loaded from disk.
  45 */
  46 #define MAX_REGISTERED_CONTENT 0x7fffU
  47
  48 /*
  49         A solid walkable node with the texture unknown_node.png.
  50
  51         For example, used on the client to display unregistered node IDs
  52         (instead of expanding the vector of node definitions each time
  53         such a node is received).
  54 */
  55 #define CONTENT_UNKNOWN 125
  56
  57 /*
  58         The common material through which the player can walk and which
  59         is transparent to light
  60 */
  61 #define CONTENT_AIR 126
  62
  63 /*
  64         Ignored node.
  65
  66         Unloaded chunks are considered to consist of this. Several other
  67         methods return this when an error occurs. Also, during
  68         map generation this means the node has not been set yet.
  69
  70         Doesn't create faces with anything and is considered being
  71         out-of-map in the game map.
  72 */
  73 #define CONTENT_IGNORE 127
  74
  75 enum LightBank
  76 {
  77         LIGHTBANK_DAY,
  78         LIGHTBANK_NIGHT
  79 };
  80
  81 /*
  82         Simple rotation enum.
  83 */
  84 enum Rotation {
  85         ROTATE_0,
  86         ROTATE_90,
  87         ROTATE_180,
  88         ROTATE_270,
  89         ROTATE_RAND,
  90 };
  91
  92 /*
  93         Masks for MapNode.param2 of flowing liquids
  94  */
  95 #define LIQUID_LEVEL_MASK 0x07
  96 #define LIQUID_FLOW_DOWN_MASK 0x08
  97
  98 //#define LIQUID_LEVEL_MASK 0x3f // better finite water
  99 //#define LIQUID_FLOW_DOWN_MASK 0x40 // not used when finite water
 100
 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)
 104
 105 #define LIQUID_INFINITY_MASK 0x80 //0b10000000
 106
 107 // mask for param2, now as for liquid
 108 #define LEVELED_MASK 0x3F
 109 #define LEVELED_MAX LEVELED_MASK
 110
 111 /*
 112         This is the stuff what the whole world consists of.
 113 */
 114
 115
 116 struct MapNode
 117 {
 118         /*
 119                 Main content
 120         */
 121         u16 param0;
 122
 123         /*
 124                 Misc parameter. Initialized to 0.
 125                 - For light_propagates() blocks, this is light intensity,
 126                   stored logarithmically from 0 to LIGHT_MAX.
 127                   Sunlight is LIGHT_SUN, which is LIGHT_MAX+1.
 128                   - Contains 2 values, day- and night lighting. Each takes 4 bits.
 129                 - Uhh... well, most blocks have light or nothing in here.
 130         */
 131         u8 param1;
 132
 133         /*
 134                 The second parameter. Initialized to 0.
 135                 E.g. direction for torches and flowing water.
 136         */
 137         u8 param2;
 138
 139         MapNode(const MapNode & n)
 140         {
 141                 *this = n;
 142         }
 143
 144         MapNode(content_t content=CONTENT_AIR, u8 a_param1=0, u8 a_param2=0)
 145         {
 146                 param0 = content;
 147                 param1 = a_param1;
 148                 param2 = a_param2;
 149         }
 150
 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);
 155
 156         bool operator==(const MapNode &other)
 157         {
 158                 return (param0 == other.param0
 159                                 && param1 == other.param1
 160                                 && param2 == other.param2);
 161         }
 162
 163         // To be used everywhere
 164         content_t getContent() const
 165         {
 166                 return param0;
 167         }
 168         void setContent(content_t c)
 169         {
 170                 param0 = c;
 171         }
 172         u8 getParam1() const
 173         {
 174                 return param1;
 175         }
 176         void setParam1(u8 p)
 177         {
 178                 param1 = p;
 179         }
 180         u8 getParam2() const
 181         {
 182                 return param2;
 183         }
 184         void setParam2(u8 p)
 185         {
 186                 param2 = p;
 187         }
 188
 189         void setLight(enum LightBank bank, u8 a_light, INodeDefManager *nodemgr);
 190         u8 getLight(enum LightBank bank, INodeDefManager *nodemgr) const;
 191         bool getLightBanks(u8 &lightday, u8 &lightnight, INodeDefManager *nodemgr) const;
 192
 193         // 0 <= daylight_factor <= 1000
 194         // 0 <= return value <= LIGHT_SUN
 195         u8 getLightBlend(u32 daylight_factor, INodeDefManager *nodemgr) const
 196         {
 197                 u8 lightday = 0;
 198                 u8 lightnight = 0;
 199                 getLightBanks(lightday, lightnight, nodemgr);
 200                 return blend_light(daylight_factor, lightday, lightnight);
 201         }
 202
 203         // 0.0 <= daylight_factor <= 1.0
 204         // 0 <= return value <= LIGHT_SUN
 205         u8 getLightBlendF1(float daylight_factor, INodeDefManager *nodemgr) const
 206         {
 207                 u8 lightday = 0;
 208                 u8 lightnight = 0;
 209                 getLightBanks(lightday, lightnight, nodemgr);
 210                 return blend_light_f1(daylight_factor, lightday, lightnight);
 211         }
 212
 213         u8 getFaceDir(INodeDefManager *nodemgr) const;
 214         u8 getWallMounted(INodeDefManager *nodemgr) const;
 215         v3s16 getWallMountedDir(INodeDefManager *nodemgr) const;
 216
 217         void rotateAlongYAxis(INodeDefManager *nodemgr, Rotation rot);
 218
 219         /*
 220                 Gets list of node boxes (used for rendering (NDT_NODEBOX))
 221         */
 222         std::vector<aabb3f> getNodeBoxes(INodeDefManager *nodemgr) const;
 223
 224         /*
 225                 Gets list of selection boxes
 226         */
 227         std::vector<aabb3f> getSelectionBoxes(INodeDefManager *nodemgr) const;
 228
 229         /*
 230                 Gets list of collision boxes
 231         */
 232         std::vector<aabb3f> getCollisionBoxes(INodeDefManager *nodemgr) const;
 233
 234         /* Liquid helpers */
 235         u8 getMaxLevel(INodeDefManager *nodemgr) const;
 236         u8 getLevel(INodeDefManager *nodemgr) const;
 237         u8 setLevel(INodeDefManager *nodemgr, s8 level = 1);
 238         u8 addLevel(INodeDefManager *nodemgr, s8 add = 1);
 239         void freezeMelt(INodeDefManager *nodemgr);
 240
 241         /*
 242                 Serialization functions
 243         */
 244
 245         static u32 serializedLength(u8 version);
 246         void serialize(u8 *dest, u8 version);
 247         void deSerialize(u8 *source, u8 version);
 248
 249         // Serializes or deserializes a list of nodes in bulk format (first the
 250         // content of all nodes, then the param1 of all nodes, then the param2
 251         // of all nodes).
 252         //   version = serialization version. Must be >= 22
 253         //   content_width = the number of bytes of content per node
 254         //   params_width = the number of bytes of params per node
 255         //   compressed = true to zlib-compress output
 256         static void serializeBulk(std::ostream &os, int version,
 257                         const MapNode *nodes, u32 nodecount,
 258                         u8 content_width, u8 params_width, bool compressed);
 259         static void deSerializeBulk(std::istream &is, int version,
 260                         MapNode *nodes, u32 nodecount,
 261                         u8 content_width, u8 params_width, bool compressed);
 262
 263 private:
 264         // Deprecated serialization methods
 265         void deSerialize_pre22(u8 *source, u8 version);
 266 };
 267
 268 #endif
 269