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.
22 #include "irrlichttypes_bloated.h"
28 #include "client/tile.h"
29 #include <IMeshManipulator.h>
32 #include "itemgroup.h"
33 #include "sound.h" // SimpleSoundSpec
34 #include "constants.h" // BS
35 #include "tileanimation.h"
37 class INodeDefManager;
38 class IItemDefManager;
50 enum ContentParamType2
55 // Flowing liquid properties
57 // Direction for chests and furnaces and such
59 // Direction for signs, torches and such
61 // Block level like FLOWINGLIQUID
63 // 2D rotation for things like plants
65 // Mesh options for plants
69 // 3 bits of palette index, then facedir
71 // 5 bits of palette index, then wallmounted
72 CPT2_COLORED_WALLMOUNTED,
73 // Glasslike framed drawtype internal liquid level, param2 values 0 to 63
74 CPT2_GLASSLIKE_LIQUID_LEVEL,
86 NODEBOX_REGULAR, // Regular block; allows buildable_to
87 NODEBOX_FIXED, // Static separately defined box(es)
88 NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
89 NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
90 NODEBOX_CONNECTED, // optionally draws nodeboxes if a neighbor node attaches
95 enum NodeBoxType type;
96 // NODEBOX_REGULAR (no parameters)
98 std::vector<aabb3f> fixed;
99 // NODEBOX_WALLMOUNTED
102 aabb3f wall_side; // being at the -X side
104 std::vector<aabb3f> connect_top;
105 std::vector<aabb3f> connect_bottom;
106 std::vector<aabb3f> connect_front;
107 std::vector<aabb3f> connect_left;
108 std::vector<aabb3f> connect_back;
109 std::vector<aabb3f> connect_right;
115 void serialize(std::ostream &os, u16 protocol_version) const;
116 void deSerialize(std::istream &is);
128 enum AutoScale : u8 {
134 enum WorldAlignMode : u8 {
138 WORLDALIGN_FORCE_NODEBOX,
141 class TextureSettings {
143 LeavesStyle leaves_style;
144 WorldAlignMode world_aligned_mode;
145 AutoScale autoscale_mode;
146 int node_texture_size;
148 bool connected_glass;
149 bool use_normal_texture;
150 bool enable_mesh_cache;
153 TextureSettings() = default;
160 // A basic solid block
164 // Do not draw face towards same kind of flowing/source liquid
166 // A very special kind of thing
168 // Glass-like, don't draw faces towards other glass
170 // Leaves-like, draw all faces no matter what
172 // Enabled -> ndt_allfaces, disabled -> ndt_normal
173 NDT_ALLFACES_OPTIONAL,
174 // Single plane perpendicular to a surface
176 // Single plane parallel to a surface
178 // 2 vertical planes in a 'X' shape diagonal to XZ axes.
179 // paramtype2 = "meshoptions" allows various forms, sizes and
180 // vertical and horizontal random offsets.
182 // Fenceposts that connect to neighbouring fenceposts with horizontal bars
184 // Selects appropriate junction texture to connect like rails to
185 // neighbouring raillikes.
187 // Custom Lua-definable structure of multiple cuboids
189 // Glass-like, draw connected frames and all visible faces.
190 // param2 > 0 defines 64 levels of internal liquid
191 // Uses 3 textures, one for frames, second for faces,
192 // optional third is a 'special tile' for the liquid.
193 NDT_GLASSLIKE_FRAMED,
194 // Draw faces slightly rotated and only on neighbouring nodes
196 // Enabled -> ndt_glasslike_framed, disabled -> ndt_glasslike
197 NDT_GLASSLIKE_FRAMED_OPTIONAL,
198 // Uses static meshes
200 // Combined plantlike-on-solid
201 NDT_PLANTLIKE_ROOTED,
204 // Mesh options for NDT_PLANTLIKE with CPT2_MESHOPTIONS
205 static const u8 MO_MASK_STYLE = 0x07;
206 static const u8 MO_BIT_RANDOM_OFFSET = 0x08;
207 static const u8 MO_BIT_SCALE_SQRT2 = 0x10;
208 static const u8 MO_BIT_RANDOM_OFFSET_Y = 0x20;
209 enum PlantlikeStyle {
217 enum AlignStyle : u8 {
220 ALIGN_STYLE_USER_DEFINED,
224 Stand-alone definition of a TileSpec (basically a server-side TileSpec)
229 std::string name = "";
230 bool backface_culling = true; // Takes effect only in special cases
231 bool tileable_horizontal = true;
232 bool tileable_vertical = true;
233 //! If true, the tile has its own color.
234 bool has_color = false;
235 //! The color of the tile.
236 video::SColor color = video::SColor(0xFFFFFFFF);
237 AlignStyle align_style = ALIGN_STYLE_NODE;
240 struct TileAnimationParams animation;
244 animation.type = TAT_NONE;
247 void serialize(std::ostream &os, u16 protocol_version) const;
248 void deSerialize(std::istream &is, u8 contentfeatures_version,
249 NodeDrawType drawtype);
252 #define CF_SPECIAL_COUNT 6
254 struct ContentFeatures
261 // up down right left back front
264 // - Currently used for flowing liquids
265 TileSpec special_tiles[CF_SPECIAL_COUNT];
266 u8 solidness; // Used when choosing which face is drawn
267 u8 visual_solidness; // When solidness=0, this tells how it looks like
268 bool backface_culling;
271 // Server-side cached callback existence for fast skipping
272 bool has_on_construct;
273 bool has_on_destruct;
274 bool has_after_destruct;
280 // --- GENERAL PROPERTIES ---
282 std::string name; // "" = undefined node
283 ItemGroupList groups; // Same as in itemdef
284 // Type of MapNode::param1
285 ContentParamType param_type;
286 // Type of MapNode::param2
287 ContentParamType2 param_type_2;
289 // --- VISUAL PROPERTIES ---
291 enum NodeDrawType drawtype;
294 scene::IMesh *mesh_ptr[24];
295 video::SColor minimap_color;
297 float visual_scale; // Misc. scale parameter
299 // These will be drawn over the base tiles.
300 TileDef tiledef_overlay[6];
301 TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
302 // If 255, the node is opaque.
303 // Otherwise it uses texture alpha.
305 // The color of the node.
307 std::string palette_name;
308 std::vector<video::SColor> *palette;
309 // Used for waving leaves/plants
311 // for NDT_CONNECTED pairing
313 std::vector<std::string> connects_to;
314 std::vector<content_t> connects_to_ids;
315 // Post effect color, drawn when the camera is inside the node.
316 video::SColor post_effect_color;
317 // Flowing liquid or snow, value = default level
320 // --- LIGHTING-RELATED ---
322 bool light_propagates;
323 bool sunlight_propagates;
324 // Amount of light the node emits
327 // --- MAP GENERATION ---
329 // True for all ground-like things like stone and mud, false for eg. trees
330 bool is_ground_content;
332 // --- INTERACTION PROPERTIES ---
334 // This is used for collision detection.
335 // Also for general solidness queries.
337 // Player can point to these
339 // Player can dig these
341 // Player can climb these
343 // Player can build on these
345 // Player cannot build to these (placement prediction disabled)
347 u32 damage_per_second;
348 // client dig prediction
349 std::string node_dig_prediction;
351 // --- LIQUID PROPERTIES ---
353 // Whether the node is non-liquid, source liquid or flowing liquid
354 enum LiquidType liquid_type;
355 // If the content is liquid, this is the flowing version of the liquid.
356 std::string liquid_alternative_flowing;
357 // If the content is liquid, this is the source version of the liquid.
358 std::string liquid_alternative_source;
359 // Viscosity for fluid flow, ranging from 1 to 7, with
360 // 1 giving almost instantaneous propagation and 7 being
361 // the slowest possible
363 // Is liquid renewable (new liquid source will be created between 2 existing)
364 bool liquid_renewable;
365 // Number of flowing liquids surrounding source
368 // Liquids flow into and replace node
374 NodeBox selection_box;
375 NodeBox collision_box;
377 // --- SOUND PROPERTIES ---
379 SimpleSoundSpec sound_footstep;
380 SimpleSoundSpec sound_dig;
381 SimpleSoundSpec sound_dug;
385 // Compatibility with old maps
386 // Set to true if paramtype used to be 'facedir_simple'
387 bool legacy_facedir_simple;
388 // Set to true if wall_mounted used to be set to true
389 bool legacy_wallmounted;
396 ~ContentFeatures() = default;
398 void serialize(std::ostream &os, u16 protocol_version) const;
399 void deSerialize(std::istream &is);
400 void serializeOld(std::ostream &os, u16 protocol_version) const;
401 void deSerializeOld(std::istream &is, int version);
403 * Since vertex alpha is no longer supported, this method
404 * adds opacity directly to the texture pixels.
406 * \param tiles array of the tile definitions.
407 * \param length length of tiles
409 void correctAlpha(TileDef *tiles, int length);
414 bool isLiquid() const{
415 return (liquid_type != LIQUID_NONE);
417 bool sameLiquid(const ContentFeatures &f) const{
418 if(!isLiquid() || !f.isLiquid()) return false;
419 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
422 int getGroup(const std::string &group) const
424 return itemgroup_get(groups, group);
428 void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
429 scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
433 class INodeDefManager {
435 INodeDefManager() = default;
436 virtual ~INodeDefManager() = default;
438 // Get node definition
439 virtual const ContentFeatures &get(content_t c) const=0;
440 virtual const ContentFeatures &get(const MapNode &n) const=0;
441 virtual bool getId(const std::string &name, content_t &result) const=0;
442 virtual content_t getId(const std::string &name) const=0;
443 // Allows "group:name" in addition to regular node names
444 // returns false if node name not found, true otherwise
445 virtual bool getIds(const std::string &name, std::vector<content_t> &result)
447 virtual const ContentFeatures &get(const std::string &name) const=0;
449 virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
451 virtual void pendNodeResolve(NodeResolver *nr)=0;
452 virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
453 virtual bool nodeboxConnects(const MapNode from, const MapNode to, u8 connect_face)=0;
455 * Returns the smallest box in node coordinates that
456 * contains all nodes' selection boxes.
458 virtual core::aabbox3d<s16> getSelectionBoxIntUnion() const=0;
461 class IWritableNodeDefManager : public INodeDefManager {
463 IWritableNodeDefManager() = default;
464 virtual ~IWritableNodeDefManager() = default;
466 // Get node definition
467 virtual const ContentFeatures &get(content_t c) const=0;
468 virtual const ContentFeatures &get(const MapNode &n) const=0;
469 virtual bool getId(const std::string &name, content_t &result) const=0;
470 // If not found, returns CONTENT_IGNORE
471 virtual content_t getId(const std::string &name) const=0;
472 // Allows "group:name" in addition to regular node names
473 virtual bool getIds(const std::string &name, std::vector<content_t> &result)
475 // If not found, returns the features of CONTENT_UNKNOWN
476 virtual const ContentFeatures &get(const std::string &name) const=0;
478 // Register node definition by name (allocate an id)
479 // If returns CONTENT_IGNORE, could not allocate id
480 virtual content_t set(const std::string &name,
481 const ContentFeatures &def)=0;
482 // If returns CONTENT_IGNORE, could not allocate id
483 virtual content_t allocateDummy(const std::string &name)=0;
485 virtual void removeNode(const std::string &name)=0;
488 Update item alias mapping.
489 Call after updating item definitions.
491 virtual void updateAliases(IItemDefManager *idef)=0;
494 Override textures from servers with ones specified in texturepack/override.txt
496 virtual void applyTextureOverrides(const std::string &override_filepath)=0;
499 Update tile textures to latest return values of TextueSource.
501 virtual void updateTextures(IGameDef *gamedef,
502 void (*progress_cbk)(void *progress_args, u32 progress, u32 max_progress),
503 void *progress_cbk_args)=0;
505 virtual void serialize(std::ostream &os, u16 protocol_version) const=0;
506 virtual void deSerialize(std::istream &is)=0;
508 virtual void setNodeRegistrationStatus(bool completed)=0;
510 virtual void pendNodeResolve(NodeResolver *nr)=0;
511 virtual bool cancelNodeResolveCallback(NodeResolver *nr)=0;
512 virtual void runNodeResolveCallbacks()=0;
513 virtual void resetNodeResolveState()=0;
514 virtual void mapNodeboxConnections()=0;
515 virtual core::aabbox3d<s16> getSelectionBoxIntUnion() const=0;
518 IWritableNodeDefManager *createNodeDefManager();
523 virtual ~NodeResolver();
524 virtual void resolveNodeNames() = 0;
526 bool getIdFromNrBacklog(content_t *result_out,
527 const std::string &node_alt, content_t c_fallback);
528 bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
529 bool all_required=false, content_t c_fallback=CONTENT_IGNORE);
531 void nodeResolveInternal();
533 u32 m_nodenames_idx = 0;
534 u32 m_nnlistsizes_idx = 0;
535 std::vector<std::string> m_nodenames;
536 std::vector<size_t> m_nnlistsizes;
537 INodeDefManager *m_ndef = nullptr;
538 bool m_resolve_done = false;