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"
28 #include "util/numeric.h"
31 #include "client/tile.h"
34 #include "itemgroup.h"
35 #include "sound.h" // SimpleSoundSpec
36 #include "constants.h" // BS
38 class INodeDefManager;
39 class IItemDefManager;
45 typedef std::list<std::pair<content_t, int> > GroupItems;
53 enum ContentParamType2
58 // Flowing liquid properties
60 // Direction for chests and furnaces and such
62 // Direction for signs, torches and such
64 // Block level like FLOWINGLIQUID
77 NODEBOX_REGULAR, // Regular block; allows buildable_to
78 NODEBOX_FIXED, // Static separately defined box(es)
79 NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
80 NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
85 enum NodeBoxType type;
86 // NODEBOX_REGULAR (no parameters)
88 std::vector<aabb3f> fixed;
89 // NODEBOX_WALLMOUNTED
92 aabb3f wall_side; // being at the -X side
98 void serialize(std::ostream &os, u16 protocol_version) const;
99 void deSerialize(std::istream &is);
106 Stand-alone definition of a TileSpec (basically a server-side TileSpec)
108 enum TileAnimationType{
110 TAT_VERTICAL_FRAMES=1,
115 bool backface_culling; // Takes effect only in special cases
116 bool tileable_horizontal;
117 bool tileable_vertical;
119 enum TileAnimationType type;
120 int aspect_w; // width for aspect ratio
121 int aspect_h; // height for aspect ratio
122 float length; // seconds
128 backface_culling = true;
129 tileable_horizontal = true;
130 tileable_vertical = true;
131 animation.type = TAT_NONE;
132 animation.aspect_w = 1;
133 animation.aspect_h = 1;
134 animation.length = 1.0;
137 void serialize(std::ostream &os, u16 protocol_version) const;
138 void deSerialize(std::istream &is);
143 NDT_NORMAL, // A basic solid block
144 NDT_AIRLIKE, // Nothing is drawn
145 NDT_LIQUID, // Do not draw face towards same kind of flowing/source liquid
146 NDT_FLOWINGLIQUID, // A very special kind of thing
147 NDT_GLASSLIKE, // Glass-like, don't draw faces towards other glass
148 NDT_ALLFACES, // Leaves-like, draw all faces no matter what
149 NDT_ALLFACES_OPTIONAL, // Fancy -> allfaces, fast -> normal
156 NDT_GLASSLIKE_FRAMED, // Glass-like, draw connected frames and all all
158 // uses 2 textures, one for frames, second for faces
159 NDT_FIRELIKE, // Draw faces slightly rotated and only on connecting nodes,
160 NDT_GLASSLIKE_FRAMED_OPTIONAL, // enabled -> connected, disabled -> Glass-like
161 // uses 2 textures, one for frames, second for faces
162 NDT_MESH, // Uses static meshes
165 #define CF_SPECIAL_COUNT 6
167 struct ContentFeatures
174 // up down right left back front
177 // - Currently used for flowing liquids
178 TileSpec special_tiles[CF_SPECIAL_COUNT];
179 u8 solidness; // Used when choosing which face is drawn
180 u8 visual_solidness; // When solidness=0, this tells how it looks like
181 bool backface_culling;
184 // Server-side cached callback existence for fast skipping
185 bool has_on_construct;
186 bool has_on_destruct;
187 bool has_after_destruct;
193 std::string name; // "" = undefined node
194 ItemGroupList groups; // Same as in itemdef
197 enum NodeDrawType drawtype;
200 scene::IMesh *mesh_ptr[24];
201 video::SColor minimap_color;
203 float visual_scale; // Misc. scale parameter
205 TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
208 // Post effect color, drawn when the camera is inside the node.
209 video::SColor post_effect_color;
211 // Type of MapNode::param1
212 ContentParamType param_type;
213 // Type of MapNode::param2
214 ContentParamType2 param_type_2;
215 // True for all ground-like things like stone and mud, false for eg. trees
216 bool is_ground_content;
217 bool light_propagates;
218 bool sunlight_propagates;
219 // This is used for collision detection.
220 // Also for general solidness queries.
222 // Player can point to these
224 // Player can dig these
226 // Player can climb these
228 // Player can build on these
230 // Player cannot build to these (placement prediction disabled)
232 // Flowing liquid or snow, value = default level
234 // Whether the node is non-liquid, source liquid or flowing liquid
235 enum LiquidType liquid_type;
236 // If the content is liquid, this is the flowing version of the liquid.
237 std::string liquid_alternative_flowing;
238 // If the content is liquid, this is the source version of the liquid.
239 std::string liquid_alternative_source;
240 // Viscosity for fluid flow, ranging from 1 to 7, with
241 // 1 giving almost instantaneous propagation and 7 being
242 // the slowest possible
244 // Is liquid renewable (new liquid source will be created between 2 existing)
245 bool liquid_renewable;
246 // Number of flowing liquids surrounding source
249 // Amount of light the node emits
251 u32 damage_per_second;
253 NodeBox selection_box;
254 NodeBox collision_box;
255 // Used for waving leaves/plants
257 // Compatibility with old maps
258 // Set to true if paramtype used to be 'facedir_simple'
259 bool legacy_facedir_simple;
260 // Set to true if wall_mounted used to be set to true
261 bool legacy_wallmounted;
264 SimpleSoundSpec sound_footstep;
265 SimpleSoundSpec sound_dig;
266 SimpleSoundSpec sound_dug;
275 void serialize(std::ostream &os, u16 protocol_version) const;
276 void deSerialize(std::istream &is);
277 void serializeOld(std::ostream &os, u16 protocol_version) const;
278 void deSerializeOld(std::istream &is, int version);
283 bool isLiquid() const{
284 return (liquid_type != LIQUID_NONE);
286 bool sameLiquid(const ContentFeatures &f) const{
287 if(!isLiquid() || !f.isLiquid()) return false;
288 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
292 class INodeDefManager {
295 virtual ~INodeDefManager(){}
296 // Get node definition
297 virtual const ContentFeatures &get(content_t c) const=0;
298 virtual const ContentFeatures &get(const MapNode &n) const=0;
299 virtual bool getId(const std::string &name, content_t &result) const=0;
300 virtual content_t getId(const std::string &name) const=0;
301 // Allows "group:name" in addition to regular node names
302 virtual void getIds(const std::string &name, std::set<content_t> &result)
304 virtual const ContentFeatures &get(const std::string &name) const=0;
306 virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
308 virtual bool getNodeRegistrationStatus() const=0;
310 virtual void pendNodeResolve(NodeResolver *nr)=0;
311 virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
314 class IWritableNodeDefManager : public INodeDefManager {
316 IWritableNodeDefManager(){}
317 virtual ~IWritableNodeDefManager(){}
318 virtual IWritableNodeDefManager* clone()=0;
319 // Get node definition
320 virtual const ContentFeatures &get(content_t c) const=0;
321 virtual const ContentFeatures &get(const MapNode &n) const=0;
322 virtual bool getId(const std::string &name, content_t &result) const=0;
323 // If not found, returns CONTENT_IGNORE
324 virtual content_t getId(const std::string &name) const=0;
325 // Allows "group:name" in addition to regular node names
326 virtual void getIds(const std::string &name, std::set<content_t> &result)
328 // If not found, returns the features of CONTENT_UNKNOWN
329 virtual const ContentFeatures &get(const std::string &name) const=0;
331 // Register node definition by name (allocate an id)
332 // If returns CONTENT_IGNORE, could not allocate id
333 virtual content_t set(const std::string &name,
334 const ContentFeatures &def)=0;
335 // If returns CONTENT_IGNORE, could not allocate id
336 virtual content_t allocateDummy(const std::string &name)=0;
339 Update item alias mapping.
340 Call after updating item definitions.
342 virtual void updateAliases(IItemDefManager *idef)=0;
345 Override textures from servers with ones specified in texturepack/override.txt
347 virtual void applyTextureOverrides(const std::string &override_filepath)=0;
350 Update tile textures to latest return values of TextueSource.
352 virtual void updateTextures(IGameDef *gamedef,
353 void (*progress_cbk)(void *progress_args, u32 progress, u32 max_progress),
354 void *progress_cbk_args)=0;
356 virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
357 virtual void deSerialize(std::istream &is)=0;
359 virtual bool getNodeRegistrationStatus() const=0;
360 virtual void setNodeRegistrationStatus(bool completed)=0;
362 virtual void pendNodeResolve(NodeResolver *nr)=0;
363 virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
364 virtual void runNodeResolveCallbacks()=0;
365 virtual void resetNodeResolveState()=0;
368 IWritableNodeDefManager *createNodeDefManager();
373 virtual ~NodeResolver();
374 virtual void resolveNodeNames() = 0;
376 bool getIdFromNrBacklog(content_t *result_out,
377 const std::string &node_alt, content_t c_fallback);
378 bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
379 bool all_required=false, content_t c_fallback=CONTENT_IGNORE);
381 void nodeResolveInternal();
384 u32 m_nnlistsizes_idx;
385 std::vector<std::string> m_nodenames;
386 std::vector<size_t> m_nnlistsizes;
387 INodeDefManager *m_ndef;