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.
20 #ifndef NODEDEF_HEADER
21 #define NODEDEF_HEADER
23 #include "irrlichttypes_bloated.h"
32 #include "itemgroup.h"
33 #include "sound.h" // SimpleSoundSpec
34 #include "constants.h" // BS
36 class IItemDefManager;
40 typedef std::list<std::pair<content_t, int> > GroupItems;
48 enum ContentParamType2
53 // Flowing liquid properties
55 // Direction for chests and furnaces and such
57 // Direction for signs, torches and such
59 // Block level like FLOWINGLIQUID
72 NODEBOX_REGULAR, // Regular block; allows buildable_to
73 NODEBOX_FIXED, // Static separately defined box(es)
74 NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
75 NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
80 enum NodeBoxType type;
81 // NODEBOX_REGULAR (no parameters)
83 std::vector<aabb3f> fixed;
84 // NODEBOX_WALLMOUNTED
87 aabb3f wall_side; // being at the -X side
93 void serialize(std::ostream &os) const;
94 void deSerialize(std::istream &is);
101 Stand-alone definition of a TileSpec (basically a server-side TileSpec)
103 enum TileAnimationType{
105 TAT_VERTICAL_FRAMES=1,
110 bool backface_culling; // Takes effect only in special cases
112 enum TileAnimationType type;
113 int aspect_w; // width for aspect ratio
114 int aspect_h; // height for aspect ratio
115 float length; // seconds
121 backface_culling = true;
122 animation.type = TAT_NONE;
123 animation.aspect_w = 1;
124 animation.aspect_h = 1;
125 animation.length = 1.0;
128 void serialize(std::ostream &os, u16 protocol_version) const;
129 void deSerialize(std::istream &is);
134 NDT_NORMAL, // A basic solid block
135 NDT_AIRLIKE, // Nothing is drawn
136 NDT_LIQUID, // Do not draw face towards same kind of flowing/source liquid
137 NDT_FLOWINGLIQUID, // A very special kind of thing
138 NDT_GLASSLIKE, // Glass-like, don't draw faces towards other glass
139 NDT_ALLFACES, // Leaves-like, draw all faces no matter what
140 NDT_ALLFACES_OPTIONAL, // Fancy -> allfaces, fast -> normal
147 NDT_GLASSLIKE_FRAMED, // Glass-like, draw connected frames and all all
149 // uses 2 textures, one for frames, second for faces
152 #define CF_SPECIAL_COUNT 2
154 struct ContentFeatures
161 // up down right left back front
164 // - Currently used for flowing liquids
165 TileSpec special_tiles[CF_SPECIAL_COUNT];
166 u8 solidness; // Used when choosing which face is drawn
167 u8 visual_solidness; // When solidness=0, this tells how it looks like
168 bool backface_culling;
171 // Server-side cached callback existence for fast skipping
172 bool has_on_construct;
173 bool has_on_destruct;
174 bool has_after_destruct;
180 std::string name; // "" = undefined node
181 ItemGroupList groups; // Same as in itemdef
184 enum NodeDrawType drawtype;
185 float visual_scale; // Misc. scale parameter
187 TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
190 // Post effect color, drawn when the camera is inside the node.
191 video::SColor post_effect_color;
192 // Type of MapNode::param1
193 ContentParamType param_type;
194 // Type of MapNode::param2
195 ContentParamType2 param_type_2;
196 // True for all ground-like things like stone and mud, false for eg. trees
197 bool is_ground_content;
198 bool light_propagates;
199 bool sunlight_propagates;
200 // This is used for collision detection.
201 // Also for general solidness queries.
203 // Player can point to these
205 // Player can dig these
207 // Player can climb these
209 // Player can build on these
211 // Player cannot build to these (placement prediction disabled)
213 // Flowing liquid or snow, value = default level
215 // Whether the node is non-liquid, source liquid or flowing liquid
216 enum LiquidType liquid_type;
217 // If the content is liquid, this is the flowing version of the liquid.
218 std::string liquid_alternative_flowing;
219 // If the content is liquid, this is the source version of the liquid.
220 std::string liquid_alternative_source;
221 // Viscosity for fluid flow, ranging from 1 to 7, with
222 // 1 giving almost instantaneous propagation and 7 being
223 // the slowest possible
225 // Is liquid renewable (new liquid source will be created between 2 existing)
226 bool liquid_renewable;
227 // Number of flowing liquids surrounding source
230 // Amount of light the node emits
232 u32 damage_per_second;
234 NodeBox selection_box;
235 // Compatibility with old maps
236 // Set to true if paramtype used to be 'facedir_simple'
237 bool legacy_facedir_simple;
238 // Set to true if wall_mounted used to be set to true
239 bool legacy_wallmounted;
242 SimpleSoundSpec sound_footstep;
243 SimpleSoundSpec sound_dig;
244 SimpleSoundSpec sound_dug;
253 void serialize(std::ostream &os, u16 protocol_version);
254 void deSerialize(std::istream &is);
255 void serializeOld(std::ostream &os, u16 protocol_version);
256 void deSerializeOld(std::istream &is, int version);
261 bool isLiquid() const{
262 return (liquid_type != LIQUID_NONE);
264 bool sameLiquid(const ContentFeatures &f) const{
265 if(!isLiquid() || !f.isLiquid()) return false;
266 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
270 class INodeDefManager
274 virtual ~INodeDefManager(){}
275 // Get node definition
276 virtual const ContentFeatures& get(content_t c) const=0;
277 virtual const ContentFeatures& get(const MapNode &n) const=0;
278 virtual bool getId(const std::string &name, content_t &result) const=0;
279 virtual content_t getId(const std::string &name) const=0;
280 // Allows "group:name" in addition to regular node names
281 virtual void getIds(const std::string &name, std::set<content_t> &result)
283 virtual const ContentFeatures& get(const std::string &name) const=0;
285 virtual void serialize(std::ostream &os, u16 protocol_version)=0;
288 class IWritableNodeDefManager : public INodeDefManager
291 IWritableNodeDefManager(){}
292 virtual ~IWritableNodeDefManager(){}
293 virtual IWritableNodeDefManager* clone()=0;
294 // Get node definition
295 virtual const ContentFeatures& get(content_t c) const=0;
296 virtual const ContentFeatures& get(const MapNode &n) const=0;
297 virtual bool getId(const std::string &name, content_t &result) const=0;
298 // If not found, returns CONTENT_IGNORE
299 virtual content_t getId(const std::string &name) const=0;
300 // Allows "group:name" in addition to regular node names
301 virtual void getIds(const std::string &name, std::set<content_t> &result)
303 // If not found, returns the features of CONTENT_UNKNOWN
304 virtual const ContentFeatures& get(const std::string &name) const=0;
306 // Register node definition by name (allocate an id)
307 // If returns CONTENT_IGNORE, could not allocate id
308 virtual content_t set(const std::string &name,
309 const ContentFeatures &def)=0;
310 // If returns CONTENT_IGNORE, could not allocate id
311 virtual content_t allocateDummy(const std::string &name)=0;
314 Update item alias mapping.
315 Call after updating item definitions.
317 virtual void updateAliases(IItemDefManager *idef)=0;
320 Update tile textures to latest return values of TextueSource.
322 virtual void updateTextures(ITextureSource *tsrc)=0;
324 virtual void serialize(std::ostream &os, u16 protocol_version)=0;
325 virtual void deSerialize(std::istream &is)=0;
328 IWritableNodeDefManager* createNodeDefManager();