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 NODEDEF_HEADER
21 #define NODEDEF_HEADER
23 #include "irrlichttypes.h"
31 #include "itemgroup.h"
32 #include "sound.h" // SimpleSoundSpec
33 class IItemDefManager;
43 enum ContentParamType2
48 // Flowing liquid properties
50 // Direction for chests and furnaces and such
52 // Direction for signs, torches and such
65 NODEBOX_REGULAR, // Regular block; allows buildable_to
66 NODEBOX_FIXED, // Static separately defined box
67 NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
72 enum NodeBoxType type;
73 // NODEBOX_REGULAR (no parameters)
75 core::aabbox3d<f32> fixed;
76 // NODEBOX_WALLMOUNTED
77 core::aabbox3d<f32> wall_top;
78 core::aabbox3d<f32> wall_bottom;
79 core::aabbox3d<f32> wall_side; // being at the -X side
82 type(NODEBOX_REGULAR),
83 // default is rail-like
84 fixed(-BS/2, -BS/2, -BS/2, BS/2, -BS/2+BS/16., BS/2),
85 // default is sign/ladder-like
86 wall_top(-BS/2, BS/2-BS/16., -BS/2, BS/2, BS/2, BS/2),
87 wall_bottom(-BS/2, -BS/2, -BS/2, BS/2, -BS/2+BS/16., BS/2),
88 wall_side(-BS/2, -BS/2, -BS/2, -BS/2+BS/16., BS/2, BS/2)
91 void serialize(std::ostream &os) const;
92 void deSerialize(std::istream &is);
101 bool backface_culling;
103 MaterialSpec(const std::string &tname_="", bool backface_culling_=true):
105 backface_culling(backface_culling_)
108 void serialize(std::ostream &os) const;
109 void deSerialize(std::istream &is);
114 NDT_NORMAL, // A basic solid block
115 NDT_AIRLIKE, // Nothing is drawn
116 NDT_LIQUID, // Do not draw face towards same kind of flowing/source liquid
117 NDT_FLOWINGLIQUID, // A very special kind of thing
118 NDT_GLASSLIKE, // Glass-like, don't draw faces towards other glass
119 NDT_ALLFACES, // Leaves-like, draw all faces no matter what
120 NDT_ALLFACES_OPTIONAL, // Fancy -> allfaces, fast -> normal
128 #define CF_SPECIAL_COUNT 2
130 struct ContentFeatures
137 // up down right left back front
140 // - Currently used for flowing liquids
141 TileSpec special_tiles[CF_SPECIAL_COUNT];
142 u8 solidness; // Used when choosing which face is drawn
143 u8 visual_solidness; // When solidness=0, this tells how it looks like
144 bool backface_culling;
151 std::string name; // "" = undefined node
152 ItemGroupList groups; // Same as in itemdef
155 enum NodeDrawType drawtype;
156 float visual_scale; // Misc. scale parameter
157 std::string tname_tiles[6];
158 MaterialSpec mspec_special[CF_SPECIAL_COUNT]; // Use setter methods
161 // Post effect color, drawn when the camera is inside the node.
162 video::SColor post_effect_color;
163 // Type of MapNode::param1
164 ContentParamType param_type;
165 // Type of MapNode::param2
166 ContentParamType2 param_type_2;
167 // True for all ground-like things like stone and mud, false for eg. trees
168 bool is_ground_content;
169 bool light_propagates;
170 bool sunlight_propagates;
171 // This is used for collision detection.
172 // Also for general solidness queries.
174 // Player can point to these
176 // Player can dig these
178 // Player can climb these
180 // Player can build on these
182 // Metadata name of node (eg. "furnace")
183 std::string metadata_name;
184 // Whether the node is non-liquid, source liquid or flowing liquid
185 enum LiquidType liquid_type;
186 // If the content is liquid, this is the flowing version of the liquid.
187 std::string liquid_alternative_flowing;
188 // If the content is liquid, this is the source version of the liquid.
189 std::string liquid_alternative_source;
190 // Viscosity for fluid flow, ranging from 1 to 7, with
191 // 1 giving almost instantaneous propagation and 7 being
192 // the slowest possible
194 // Amount of light the node emits
196 u32 damage_per_second;
197 NodeBox selection_box;
198 // Compatibility with old maps
199 // Set to true if paramtype used to be 'facedir_simple'
200 bool legacy_facedir_simple;
201 // Set to true if wall_mounted used to be set to true
202 bool legacy_wallmounted;
205 SimpleSoundSpec sound_footstep;
206 SimpleSoundSpec sound_dig;
207 SimpleSoundSpec sound_dug;
216 void serialize(std::ostream &os);
217 void deSerialize(std::istream &is);
222 bool isLiquid() const{
223 return (liquid_type != LIQUID_NONE);
225 bool sameLiquid(const ContentFeatures &f) const{
226 if(!isLiquid() || !f.isLiquid()) return false;
227 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
231 class INodeDefManager
235 virtual ~INodeDefManager(){}
236 // Get node definition
237 virtual const ContentFeatures& get(content_t c) const=0;
238 virtual const ContentFeatures& get(const MapNode &n) const=0;
239 virtual bool getId(const std::string &name, content_t &result) const=0;
240 virtual content_t getId(const std::string &name) const=0;
241 // Allows "group:name" in addition to regular node names
242 virtual void getIds(const std::string &name, std::set<content_t> &result)
244 virtual const ContentFeatures& get(const std::string &name) const=0;
246 virtual void serialize(std::ostream &os)=0;
249 class IWritableNodeDefManager : public INodeDefManager
252 IWritableNodeDefManager(){}
253 virtual ~IWritableNodeDefManager(){}
254 virtual IWritableNodeDefManager* clone()=0;
255 // Get node definition
256 virtual const ContentFeatures& get(content_t c) const=0;
257 virtual const ContentFeatures& get(const MapNode &n) const=0;
258 virtual bool getId(const std::string &name, content_t &result) const=0;
259 virtual content_t getId(const std::string &name) const=0;
260 // Allows "group:name" in addition to regular node names
261 virtual void getIds(const std::string &name, std::set<content_t> &result)
263 // If not found, returns the features of CONTENT_IGNORE
264 virtual const ContentFeatures& get(const std::string &name) const=0;
266 // Register node definition
267 virtual void set(content_t c, const ContentFeatures &def)=0;
268 // Register node definition by name (allocate an id)
269 // If returns CONTENT_IGNORE, could not allocate id
270 virtual content_t set(const std::string &name,
271 const ContentFeatures &def)=0;
272 // If returns CONTENT_IGNORE, could not allocate id
273 virtual content_t allocateDummy(const std::string &name)=0;
276 Update item alias mapping.
277 Call after updating item definitions.
279 virtual void updateAliases(IItemDefManager *idef)=0;
282 Update tile textures to latest return values of TextueSource.
283 Call after updating the texture atlas of a TextureSource.
285 virtual void updateTextures(ITextureSource *tsrc)=0;
287 virtual void serialize(std::ostream &os)=0;
288 virtual void deSerialize(std::istream &is)=0;
291 IWritableNodeDefManager* createNodeDefManager();