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 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"
31 #include "itemgroup.h"
32 #include "sound.h" // SimpleSoundSpec
33 #include "constants.h" // BS
35 class IItemDefManager;
45 enum ContentParamType2
50 // Flowing liquid properties
52 // Direction for chests and furnaces and such
54 // Direction for signs, torches and such
67 NODEBOX_REGULAR, // Regular block; allows buildable_to
68 NODEBOX_FIXED, // Static separately defined box(es)
69 NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
74 enum NodeBoxType type;
75 // NODEBOX_REGULAR (no parameters)
77 std::vector<aabb3f> fixed;
78 // NODEBOX_WALLMOUNTED
81 aabb3f wall_side; // being at the -X side
87 void serialize(std::ostream &os) const;
88 void deSerialize(std::istream &is);
95 Stand-alone definition of a TileSpec (basically a server-side TileSpec)
97 enum TileAnimationType{
99 TAT_VERTICAL_FRAMES=1,
104 bool backface_culling; // Takes effect only in special cases
106 enum TileAnimationType type;
107 int aspect_w; // width for aspect ratio
108 int aspect_h; // height for aspect ratio
109 float length; // seconds
115 backface_culling = true;
116 animation.type = TAT_NONE;
117 animation.aspect_w = 1;
118 animation.aspect_h = 1;
119 animation.length = 1.0;
122 void serialize(std::ostream &os) const;
123 void deSerialize(std::istream &is);
128 NDT_NORMAL, // A basic solid block
129 NDT_AIRLIKE, // Nothing is drawn
130 NDT_LIQUID, // Do not draw face towards same kind of flowing/source liquid
131 NDT_FLOWINGLIQUID, // A very special kind of thing
132 NDT_GLASSLIKE, // Glass-like, don't draw faces towards other glass
133 NDT_ALLFACES, // Leaves-like, draw all faces no matter what
134 NDT_ALLFACES_OPTIONAL, // Fancy -> allfaces, fast -> normal
143 #define CF_SPECIAL_COUNT 2
145 struct ContentFeatures
152 // up down right left back front
155 // - Currently used for flowing liquids
156 TileSpec special_tiles[CF_SPECIAL_COUNT];
157 u8 solidness; // Used when choosing which face is drawn
158 u8 visual_solidness; // When solidness=0, this tells how it looks like
159 bool backface_culling;
162 // Server-side cached callback existence for fast skipping
163 bool has_on_construct;
164 bool has_on_destruct;
165 bool has_after_destruct;
171 std::string name; // "" = undefined node
172 ItemGroupList groups; // Same as in itemdef
175 enum NodeDrawType drawtype;
176 float visual_scale; // Misc. scale parameter
178 TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
181 // Post effect color, drawn when the camera is inside the node.
182 video::SColor post_effect_color;
183 // Type of MapNode::param1
184 ContentParamType param_type;
185 // Type of MapNode::param2
186 ContentParamType2 param_type_2;
187 // True for all ground-like things like stone and mud, false for eg. trees
188 bool is_ground_content;
189 bool light_propagates;
190 bool sunlight_propagates;
191 // This is used for collision detection.
192 // Also for general solidness queries.
194 // Player can point to these
196 // Player can dig these
198 // Player can climb these
200 // Player can build on these
202 // Whether the node is non-liquid, source liquid or flowing liquid
203 enum LiquidType liquid_type;
204 // If the content is liquid, this is the flowing version of the liquid.
205 std::string liquid_alternative_flowing;
206 // If the content is liquid, this is the source version of the liquid.
207 std::string liquid_alternative_source;
208 // Viscosity for fluid flow, ranging from 1 to 7, with
209 // 1 giving almost instantaneous propagation and 7 being
210 // the slowest possible
212 // Is liquid renewable (new liquid source will be created between 2 existing)
213 bool liquid_renewable;
214 // Amount of light the node emits
216 u32 damage_per_second;
218 NodeBox selection_box;
219 // Compatibility with old maps
220 // Set to true if paramtype used to be 'facedir_simple'
221 bool legacy_facedir_simple;
222 // Set to true if wall_mounted used to be set to true
223 bool legacy_wallmounted;
226 SimpleSoundSpec sound_footstep;
227 SimpleSoundSpec sound_dig;
228 SimpleSoundSpec sound_dug;
237 void serialize(std::ostream &os, u16 protocol_version);
238 void deSerialize(std::istream &is);
239 void serializeOld(std::ostream &os, u16 protocol_version);
240 void deSerializeOld(std::istream &is, int version);
245 bool isLiquid() const{
246 return (liquid_type != LIQUID_NONE);
248 bool sameLiquid(const ContentFeatures &f) const{
249 if(!isLiquid() || !f.isLiquid()) return false;
250 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
254 class INodeDefManager
258 virtual ~INodeDefManager(){}
259 // Get node definition
260 virtual const ContentFeatures& get(content_t c) const=0;
261 virtual const ContentFeatures& get(const MapNode &n) const=0;
262 virtual bool getId(const std::string &name, content_t &result) const=0;
263 virtual content_t getId(const std::string &name) const=0;
264 // Allows "group:name" in addition to regular node names
265 virtual void getIds(const std::string &name, std::set<content_t> &result)
267 virtual const ContentFeatures& get(const std::string &name) const=0;
269 virtual void serialize(std::ostream &os, u16 protocol_version)=0;
272 class IWritableNodeDefManager : public INodeDefManager
275 IWritableNodeDefManager(){}
276 virtual ~IWritableNodeDefManager(){}
277 virtual IWritableNodeDefManager* clone()=0;
278 // Get node definition
279 virtual const ContentFeatures& get(content_t c) const=0;
280 virtual const ContentFeatures& get(const MapNode &n) const=0;
281 virtual bool getId(const std::string &name, content_t &result) const=0;
282 virtual content_t getId(const std::string &name) const=0;
283 // Allows "group:name" in addition to regular node names
284 virtual void getIds(const std::string &name, std::set<content_t> &result)
286 // If not found, returns the features of CONTENT_IGNORE
287 virtual const ContentFeatures& get(const std::string &name) const=0;
289 // Register node definition
290 virtual void set(content_t c, const ContentFeatures &def)=0;
291 // Register node definition by name (allocate an id)
292 // If returns CONTENT_IGNORE, could not allocate id
293 virtual content_t set(const std::string &name,
294 const ContentFeatures &def)=0;
295 // If returns CONTENT_IGNORE, could not allocate id
296 virtual content_t allocateDummy(const std::string &name)=0;
299 Update item alias mapping.
300 Call after updating item definitions.
302 virtual void updateAliases(IItemDefManager *idef)=0;
305 Update tile textures to latest return values of TextueSource.
306 Call after updating the texture atlas of a TextureSource.
308 virtual void updateTextures(ITextureSource *tsrc)=0;
310 virtual void serialize(std::ostream &os, u16 protocol_version)=0;
311 virtual void deSerialize(std::istream &is)=0;
314 IWritableNodeDefManager* createNodeDefManager();