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"
35 #include "itemgroup.h"
36 #include "sound.h" // SimpleSoundSpec
37 #include "constants.h" // BS
38 #include "tileanimation.h"
40 class INodeDefManager;
41 class IItemDefManager;
47 typedef std::list<std::pair<content_t, int> > GroupItems;
55 enum ContentParamType2
60 // Flowing liquid properties
62 // Direction for chests and furnaces and such
64 // Direction for signs, torches and such
66 // Block level like FLOWINGLIQUID
68 // 2D rotation for things like plants
70 // Mesh options for plants
74 // 3 bits of palette index, then facedir
76 // 5 bits of palette index, then wallmounted
77 CPT2_COLORED_WALLMOUNTED,
78 // Glasslike framed drawtype internal liquid level, param2 values 0 to 63
79 CPT2_GLASSLIKE_LIQUID_LEVEL,
91 NODEBOX_REGULAR, // Regular block; allows buildable_to
92 NODEBOX_FIXED, // Static separately defined box(es)
93 NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
94 NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
95 NODEBOX_CONNECTED, // optionally draws nodeboxes if a neighbor node attaches
100 enum NodeBoxType type;
101 // NODEBOX_REGULAR (no parameters)
103 std::vector<aabb3f> fixed;
104 // NODEBOX_WALLMOUNTED
107 aabb3f wall_side; // being at the -X side
109 std::vector<aabb3f> connect_top;
110 std::vector<aabb3f> connect_bottom;
111 std::vector<aabb3f> connect_front;
112 std::vector<aabb3f> connect_left;
113 std::vector<aabb3f> connect_back;
114 std::vector<aabb3f> connect_right;
120 void serialize(std::ostream &os, u16 protocol_version) const;
121 void deSerialize(std::istream &is);
133 class TextureSettings {
135 LeavesStyle leaves_style;
137 bool connected_glass;
138 bool use_normal_texture;
139 bool enable_mesh_cache;
149 // A basic solid block
153 // Do not draw face towards same kind of flowing/source liquid
155 // A very special kind of thing
157 // Glass-like, don't draw faces towards other glass
159 // Leaves-like, draw all faces no matter what
161 // Enabled -> ndt_allfaces, disabled -> ndt_normal
162 NDT_ALLFACES_OPTIONAL,
163 // Single plane perpendicular to a surface
165 // Single plane parallel to a surface
167 // 2 vertical planes in a 'X' shape diagonal to XZ axes.
168 // paramtype2 = "meshoptions" allows various forms, sizes and
169 // vertical and horizontal random offsets.
171 // Fenceposts that connect to neighbouring fenceposts with horizontal bars
173 // Selects appropriate junction texture to connect like rails to
174 // neighbouring raillikes.
176 // Custom Lua-definable structure of multiple cuboids
178 // Glass-like, draw connected frames and all visible faces.
179 // param2 > 0 defines 64 levels of internal liquid
180 // Uses 3 textures, one for frames, second for faces,
181 // optional third is a 'special tile' for the liquid.
182 NDT_GLASSLIKE_FRAMED,
183 // Draw faces slightly rotated and only on neighbouring nodes
185 // Enabled -> ndt_glasslike_framed, disabled -> ndt_glasslike
186 NDT_GLASSLIKE_FRAMED_OPTIONAL,
187 // Uses static meshes
191 // Mesh options for NDT_PLANTLIKE with CPT2_MESHOPTIONS
192 static const u8 MO_MASK_STYLE = 0x07;
193 static const u8 MO_BIT_RANDOM_OFFSET = 0x08;
194 static const u8 MO_BIT_SCALE_SQRT2 = 0x10;
195 static const u8 MO_BIT_RANDOM_OFFSET_Y = 0x20;
196 enum PlantlikeStyle {
205 Stand-alone definition of a TileSpec (basically a server-side TileSpec)
210 std::string name = "";
211 bool backface_culling = true; // Takes effect only in special cases
212 bool tileable_horizontal = true;
213 bool tileable_vertical = true;
214 //! If true, the tile has its own color.
215 bool has_color = false;
216 //! The color of the tile.
217 video::SColor color = video::SColor(0xFFFFFFFF);
219 struct TileAnimationParams animation;
223 animation.type = TAT_NONE;
226 void serialize(std::ostream &os, u16 protocol_version) const;
227 void deSerialize(std::istream &is, const u8 contentfeatures_version, const NodeDrawType drawtype);
230 #define CF_SPECIAL_COUNT 6
232 struct ContentFeatures
239 // up down right left back front
242 // - Currently used for flowing liquids
243 TileSpec special_tiles[CF_SPECIAL_COUNT];
244 u8 solidness; // Used when choosing which face is drawn
245 u8 visual_solidness; // When solidness=0, this tells how it looks like
246 bool backface_culling;
249 // Server-side cached callback existence for fast skipping
250 bool has_on_construct;
251 bool has_on_destruct;
252 bool has_after_destruct;
258 // --- GENERAL PROPERTIES ---
260 std::string name; // "" = undefined node
261 ItemGroupList groups; // Same as in itemdef
262 // Type of MapNode::param1
263 ContentParamType param_type;
264 // Type of MapNode::param2
265 ContentParamType2 param_type_2;
267 // --- VISUAL PROPERTIES ---
269 enum NodeDrawType drawtype;
272 scene::IMesh *mesh_ptr[24];
273 video::SColor minimap_color;
275 float visual_scale; // Misc. scale parameter
277 // These will be drawn over the base tiles.
278 TileDef tiledef_overlay[6];
279 TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
280 // If 255, the node is opaque.
281 // Otherwise it uses texture alpha.
283 // The color of the node.
285 std::string palette_name;
286 std::vector<video::SColor> *palette;
287 // Used for waving leaves/plants
289 // for NDT_CONNECTED pairing
291 std::vector<std::string> connects_to;
292 std::set<content_t> connects_to_ids;
293 // Post effect color, drawn when the camera is inside the node.
294 video::SColor post_effect_color;
295 // Flowing liquid or snow, value = default level
298 // --- LIGHTING-RELATED ---
300 bool light_propagates;
301 bool sunlight_propagates;
302 // Amount of light the node emits
305 // --- MAP GENERATION ---
307 // True for all ground-like things like stone and mud, false for eg. trees
308 bool is_ground_content;
310 // --- INTERACTION PROPERTIES ---
312 // This is used for collision detection.
313 // Also for general solidness queries.
315 // Player can point to these
317 // Player can dig these
319 // Player can climb these
321 // Player can build on these
323 // Player cannot build to these (placement prediction disabled)
325 u32 damage_per_second;
327 // --- LIQUID PROPERTIES ---
329 // Whether the node is non-liquid, source liquid or flowing liquid
330 enum LiquidType liquid_type;
331 // If the content is liquid, this is the flowing version of the liquid.
332 std::string liquid_alternative_flowing;
333 // If the content is liquid, this is the source version of the liquid.
334 std::string liquid_alternative_source;
335 // Viscosity for fluid flow, ranging from 1 to 7, with
336 // 1 giving almost instantaneous propagation and 7 being
337 // the slowest possible
339 // Is liquid renewable (new liquid source will be created between 2 existing)
340 bool liquid_renewable;
341 // Number of flowing liquids surrounding source
344 // Liquids flow into and replace node
350 NodeBox selection_box;
351 NodeBox collision_box;
353 // --- SOUND PROPERTIES ---
355 SimpleSoundSpec sound_footstep;
356 SimpleSoundSpec sound_dig;
357 SimpleSoundSpec sound_dug;
361 // Compatibility with old maps
362 // Set to true if paramtype used to be 'facedir_simple'
363 bool legacy_facedir_simple;
364 // Set to true if wall_mounted used to be set to true
365 bool legacy_wallmounted;
374 void serialize(std::ostream &os, u16 protocol_version) const;
375 void deSerialize(std::istream &is);
376 void serializeOld(std::ostream &os, u16 protocol_version) const;
377 void deSerializeOld(std::istream &is, int version);
379 * Since vertex alpha is no longer supported, this method
380 * adds opacity directly to the texture pixels.
382 * \param tiles array of the tile definitions.
383 * \param length length of tiles
385 void correctAlpha(TileDef *tiles, int length);
390 bool isLiquid() const{
391 return (liquid_type != LIQUID_NONE);
393 bool sameLiquid(const ContentFeatures &f) const{
394 if(!isLiquid() || !f.isLiquid()) return false;
395 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
398 int getGroup(const std::string &group) const
400 return itemgroup_get(groups, group);
404 void fillTileAttribs(ITextureSource *tsrc, TileLayer *tile, TileDef *tiledef,
405 u32 shader_id, bool use_normal_texture, bool backface_culling,
407 void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
408 scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
412 class INodeDefManager {
415 virtual ~INodeDefManager(){}
416 // Get node definition
417 virtual const ContentFeatures &get(content_t c) const=0;
418 virtual const ContentFeatures &get(const MapNode &n) const=0;
419 virtual bool getId(const std::string &name, content_t &result) const=0;
420 virtual content_t getId(const std::string &name) const=0;
421 // Allows "group:name" in addition to regular node names
422 // returns false if node name not found, true otherwise
423 virtual bool getIds(const std::string &name, std::set<content_t> &result)
425 virtual const ContentFeatures &get(const std::string &name) const=0;
427 virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
429 virtual void pendNodeResolve(NodeResolver *nr)=0;
430 virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
431 virtual bool nodeboxConnects(const MapNode from, const MapNode to, u8 connect_face)=0;
433 * Returns the smallest box in node coordinates that
434 * contains all nodes' selection boxes.
436 virtual core::aabbox3d<s16> getSelectionBoxIntUnion() const=0;
439 class IWritableNodeDefManager : public INodeDefManager {
441 IWritableNodeDefManager(){}
442 virtual ~IWritableNodeDefManager(){}
443 virtual IWritableNodeDefManager* clone()=0;
444 // Get node definition
445 virtual const ContentFeatures &get(content_t c) const=0;
446 virtual const ContentFeatures &get(const MapNode &n) const=0;
447 virtual bool getId(const std::string &name, content_t &result) const=0;
448 // If not found, returns CONTENT_IGNORE
449 virtual content_t getId(const std::string &name) const=0;
450 // Allows "group:name" in addition to regular node names
451 virtual bool getIds(const std::string &name, std::set<content_t> &result)
453 // If not found, returns the features of CONTENT_UNKNOWN
454 virtual const ContentFeatures &get(const std::string &name) const=0;
456 // Register node definition by name (allocate an id)
457 // If returns CONTENT_IGNORE, could not allocate id
458 virtual content_t set(const std::string &name,
459 const ContentFeatures &def)=0;
460 // If returns CONTENT_IGNORE, could not allocate id
461 virtual content_t allocateDummy(const std::string &name)=0;
463 virtual void removeNode(const std::string &name)=0;
466 Update item alias mapping.
467 Call after updating item definitions.
469 virtual void updateAliases(IItemDefManager *idef)=0;
472 Override textures from servers with ones specified in texturepack/override.txt
474 virtual void applyTextureOverrides(const std::string &override_filepath)=0;
477 Update tile textures to latest return values of TextueSource.
479 virtual void updateTextures(IGameDef *gamedef,
480 void (*progress_cbk)(void *progress_args, u32 progress, u32 max_progress),
481 void *progress_cbk_args)=0;
483 virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
484 virtual void deSerialize(std::istream &is)=0;
486 virtual void setNodeRegistrationStatus(bool completed)=0;
488 virtual void pendNodeResolve(NodeResolver *nr)=0;
489 virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
490 virtual void runNodeResolveCallbacks()=0;
491 virtual void resetNodeResolveState()=0;
492 virtual void mapNodeboxConnections()=0;
493 virtual core::aabbox3d<s16> getSelectionBoxIntUnion() const=0;
496 IWritableNodeDefManager *createNodeDefManager();
501 virtual ~NodeResolver();
502 virtual void resolveNodeNames() = 0;
504 bool getIdFromNrBacklog(content_t *result_out,
505 const std::string &node_alt, content_t c_fallback);
506 bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
507 bool all_required=false, content_t c_fallback=CONTENT_IGNORE);
509 void nodeResolveInternal();
511 u32 m_nodenames_idx = 0;
512 u32 m_nnlistsizes_idx = 0;
513 std::vector<std::string> m_nodenames;
514 std::vector<size_t> m_nnlistsizes;
515 INodeDefManager *m_ndef = nullptr;
516 bool m_resolve_done = false;