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"
27 #include "nameidmapping.h"
29 #include "client/tile.h"
30 #include <IMeshManipulator.h>
33 #include "itemgroup.h"
34 #include "sound.h" // SimpleSoundSpec
35 #include "constants.h" // BS
36 #include "texture_override.h" // TextureOverride
37 #include "tileanimation.h"
39 // PROTOCOL_VERSION >= 37
40 static const u8 CONTENTFEATURES_VERSION = 13;
42 class IItemDefManager;
54 enum ContentParamType2
59 // Flowing liquid properties
61 // Direction for chests and furnaces and such
63 // Direction for signs, torches and such
65 // Block level like FLOWINGLIQUID
67 // 2D rotation for things like plants
69 // Mesh options for plants
73 // 3 bits of palette index, then facedir
75 // 5 bits of palette index, then wallmounted
76 CPT2_COLORED_WALLMOUNTED,
77 // Glasslike framed drawtype internal liquid level, param2 values 0 to 63
78 CPT2_GLASSLIKE_LIQUID_LEVEL,
90 NODEBOX_REGULAR, // Regular block; allows buildable_to
91 NODEBOX_FIXED, // Static separately defined box(es)
92 NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
93 NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
94 NODEBOX_CONNECTED, // optionally draws nodeboxes if a neighbor node attaches
99 enum NodeBoxType type;
100 // NODEBOX_REGULAR (no parameters)
102 std::vector<aabb3f> fixed;
103 // NODEBOX_WALLMOUNTED
106 aabb3f wall_side; // being at the -X side
108 std::vector<aabb3f> connect_top;
109 std::vector<aabb3f> connect_bottom;
110 std::vector<aabb3f> connect_front;
111 std::vector<aabb3f> connect_left;
112 std::vector<aabb3f> connect_back;
113 std::vector<aabb3f> connect_right;
114 std::vector<aabb3f> disconnected_top;
115 std::vector<aabb3f> disconnected_bottom;
116 std::vector<aabb3f> disconnected_front;
117 std::vector<aabb3f> disconnected_left;
118 std::vector<aabb3f> disconnected_back;
119 std::vector<aabb3f> disconnected_right;
120 std::vector<aabb3f> disconnected;
121 std::vector<aabb3f> disconnected_sides;
127 void serialize(std::ostream &os, u16 protocol_version) const;
128 void deSerialize(std::istream &is);
140 enum AutoScale : u8 {
146 enum WorldAlignMode : u8 {
150 WORLDALIGN_FORCE_NODEBOX,
153 class TextureSettings {
155 LeavesStyle leaves_style;
156 WorldAlignMode world_aligned_mode;
157 AutoScale autoscale_mode;
158 int node_texture_size;
160 bool connected_glass;
161 bool enable_mesh_cache;
164 TextureSettings() = default;
171 // A basic solid block
175 // Do not draw face towards same kind of flowing/source liquid
177 // A very special kind of thing
179 // Glass-like, don't draw faces towards other glass
181 // Leaves-like, draw all faces no matter what
183 // Enabled -> ndt_allfaces, disabled -> ndt_normal
184 NDT_ALLFACES_OPTIONAL,
185 // Single plane perpendicular to a surface
187 // Single plane parallel to a surface
189 // 2 vertical planes in a 'X' shape diagonal to XZ axes.
190 // paramtype2 = "meshoptions" allows various forms, sizes and
191 // vertical and horizontal random offsets.
193 // Fenceposts that connect to neighbouring fenceposts with horizontal bars
195 // Selects appropriate junction texture to connect like rails to
196 // neighbouring raillikes.
198 // Custom Lua-definable structure of multiple cuboids
200 // Glass-like, draw connected frames and all visible faces.
201 // param2 > 0 defines 64 levels of internal liquid
202 // Uses 3 textures, one for frames, second for faces,
203 // optional third is a 'special tile' for the liquid.
204 NDT_GLASSLIKE_FRAMED,
205 // Draw faces slightly rotated and only on neighbouring nodes
207 // Enabled -> ndt_glasslike_framed, disabled -> ndt_glasslike
208 NDT_GLASSLIKE_FRAMED_OPTIONAL,
209 // Uses static meshes
211 // Combined plantlike-on-solid
212 NDT_PLANTLIKE_ROOTED,
215 // Mesh options for NDT_PLANTLIKE with CPT2_MESHOPTIONS
216 static const u8 MO_MASK_STYLE = 0x07;
217 static const u8 MO_BIT_RANDOM_OFFSET = 0x08;
218 static const u8 MO_BIT_SCALE_SQRT2 = 0x10;
219 static const u8 MO_BIT_RANDOM_OFFSET_Y = 0x20;
220 enum PlantlikeStyle {
228 enum AlignStyle : u8 {
231 ALIGN_STYLE_USER_DEFINED,
235 Stand-alone definition of a TileSpec (basically a server-side TileSpec)
240 std::string name = "";
241 bool backface_culling = true; // Takes effect only in special cases
242 bool tileable_horizontal = true;
243 bool tileable_vertical = true;
244 //! If true, the tile has its own color.
245 bool has_color = false;
246 //! The color of the tile.
247 video::SColor color = video::SColor(0xFFFFFFFF);
248 AlignStyle align_style = ALIGN_STYLE_NODE;
251 struct TileAnimationParams animation;
255 animation.type = TAT_NONE;
258 void serialize(std::ostream &os, u16 protocol_version) const;
259 void deSerialize(std::istream &is, u8 contentfeatures_version,
260 NodeDrawType drawtype);
263 // Defines the number of special tiles per nodedef
265 // NOTE: When changing this value, the enum entries of OverrideTarget and
266 // parser in TextureOverrideSource must be updated so that all special
267 // tiles can be overridden.
268 #define CF_SPECIAL_COUNT 6
270 struct ContentFeatures
277 // up down right left back front
280 // - Currently used for flowing liquids
281 TileSpec special_tiles[CF_SPECIAL_COUNT];
282 u8 solidness; // Used when choosing which face is drawn
283 u8 visual_solidness; // When solidness=0, this tells how it looks like
284 bool backface_culling;
287 // Server-side cached callback existence for fast skipping
288 bool has_on_construct;
289 bool has_on_destruct;
290 bool has_after_destruct;
296 // --- GENERAL PROPERTIES ---
298 std::string name; // "" = undefined node
299 ItemGroupList groups; // Same as in itemdef
300 // Type of MapNode::param1
301 ContentParamType param_type;
302 // Type of MapNode::param2
303 ContentParamType2 param_type_2;
305 // --- VISUAL PROPERTIES ---
307 enum NodeDrawType drawtype;
310 scene::IMesh *mesh_ptr[24];
311 video::SColor minimap_color;
313 float visual_scale; // Misc. scale parameter
315 // These will be drawn over the base tiles.
316 TileDef tiledef_overlay[6];
317 TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
318 // If 255, the node is opaque.
319 // Otherwise it uses texture alpha.
321 // The color of the node.
323 std::string palette_name;
324 std::vector<video::SColor> *palette;
325 // Used for waving leaves/plants
327 // for NDT_CONNECTED pairing
329 std::vector<std::string> connects_to;
330 std::vector<content_t> connects_to_ids;
331 // Post effect color, drawn when the camera is inside the node.
332 video::SColor post_effect_color;
333 // Flowing liquid or leveled nodebox, value = default level
335 // Maximum value for leveled nodes
338 // --- LIGHTING-RELATED ---
340 bool light_propagates;
341 bool sunlight_propagates;
342 // Amount of light the node emits
345 // --- MAP GENERATION ---
347 // True for all ground-like things like stone and mud, false for eg. trees
348 bool is_ground_content;
350 // --- INTERACTION PROPERTIES ---
352 // This is used for collision detection.
353 // Also for general solidness queries.
355 // Player can point to these
357 // Player can dig these
359 // Player can climb these
361 // Player can build on these
363 // Player cannot build to these (placement prediction disabled)
365 u32 damage_per_second;
366 // client dig prediction
367 std::string node_dig_prediction;
369 // --- LIQUID PROPERTIES ---
371 // Whether the node is non-liquid, source liquid or flowing liquid
372 enum LiquidType liquid_type;
373 // If the content is liquid, this is the flowing version of the liquid.
374 std::string liquid_alternative_flowing;
375 content_t liquid_alternative_flowing_id;
376 // If the content is liquid, this is the source version of the liquid.
377 std::string liquid_alternative_source;
378 content_t liquid_alternative_source_id;
379 // Viscosity for fluid flow, ranging from 1 to 7, with
380 // 1 giving almost instantaneous propagation and 7 being
381 // the slowest possible
383 // Is liquid renewable (new liquid source will be created between 2 existing)
384 bool liquid_renewable;
385 // Number of flowing liquids surrounding source
388 // Liquids flow into and replace node
394 NodeBox selection_box;
395 NodeBox collision_box;
397 // --- SOUND PROPERTIES ---
399 SimpleSoundSpec sound_footstep;
400 SimpleSoundSpec sound_dig;
401 SimpleSoundSpec sound_dug;
405 // Compatibility with old maps
406 // Set to true if paramtype used to be 'facedir_simple'
407 bool legacy_facedir_simple;
408 // Set to true if wall_mounted used to be set to true
409 bool legacy_wallmounted;
418 void serialize(std::ostream &os, u16 protocol_version) const;
419 void deSerialize(std::istream &is);
423 * Checks if any tile texture has any transparent pixels.
424 * Prints a warning and returns true if that is the case, false otherwise.
425 * This is supposed to be used for use_texture_alpha backwards compatibility.
427 bool textureAlphaCheck(ITextureSource *tsrc, const TileDef *tiles,
435 bool needsBackfaceCulling() const
443 case NDT_PLANTLIKE_ROOTED:
451 bool isLiquid() const{
452 return (liquid_type != LIQUID_NONE);
454 bool sameLiquid(const ContentFeatures &f) const{
455 if(!isLiquid() || !f.isLiquid()) return false;
456 return (liquid_alternative_flowing_id == f.liquid_alternative_flowing_id);
459 int getGroup(const std::string &group) const
461 return itemgroup_get(groups, group);
465 void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
466 scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
471 * @brief This class is for getting the actual properties of nodes from their
474 * @details The nodes on the map are represented by three numbers (see MapNode).
475 * The first number (param0) is the type of a node. All node types have own
476 * properties (see ContentFeatures). This class is for storing and getting the
477 * properties of nodes.
478 * The manager is first filled with registered nodes, then as the game begins,
479 * functions only get `const` pointers to it, to prevent modification of
482 class NodeDefManager {
485 * Creates a NodeDefManager, and registers three ContentFeatures:
486 * \ref CONTENT_AIR, \ref CONTENT_UNKNOWN and \ref CONTENT_IGNORE.
492 * Returns the properties for the given content type.
493 * @param c content type of a node
494 * @return properties of the given content type, or \ref CONTENT_UNKNOWN
495 * if the given content type is not registered.
497 inline const ContentFeatures& get(content_t c) const {
499 c < m_content_features.size() ?
500 m_content_features[c] : m_content_features[CONTENT_UNKNOWN];
504 * Returns the properties of the given node.
505 * @param n a map node
506 * @return properties of the given node or @ref CONTENT_UNKNOWN if the
507 * given content type is not registered.
509 inline const ContentFeatures& get(const MapNode &n) const {
510 return get(n.getContent());
514 * Returns the node properties for a node name.
515 * @param name name of a node
516 * @return properties of the given node or @ref CONTENT_UNKNOWN if
519 const ContentFeatures& get(const std::string &name) const;
522 * Returns the content ID for the given name.
523 * @param name a node name
524 * @param[out] result will contain the content ID if found, otherwise
526 * @return true if the ID was found, false otherwise
528 bool getId(const std::string &name, content_t &result) const;
531 * Returns the content ID for the given name.
532 * @param name a node name
533 * @return ID of the node or @ref CONTENT_IGNORE if not found
535 content_t getId(const std::string &name) const;
538 * Returns the content IDs of the given node name or node group name.
539 * Group names start with "group:".
540 * @param name a node name or node group name
541 * @param[out] result will be appended with matching IDs
542 * @return true if `name` is a valid node name or a (not necessarily
545 bool getIds(const std::string &name, std::vector<content_t> &result) const;
548 * Returns the smallest box in integer node coordinates that
549 * contains all nodes' selection boxes. The returned box might be larger
550 * than the minimal size if the largest node is removed from the manager.
552 inline core::aabbox3d<s16> getSelectionBoxIntUnion() const {
553 return m_selection_box_int_union;
557 * Checks whether a node connects to an adjacent node.
558 * @param from the node to be checked
559 * @param to the adjacent node
560 * @param connect_face a bit field indicating which face of the node is
561 * adjacent to the other node.
562 * Bits: +y (least significant), -y, -z, -x, +z, +x (most significant).
563 * @return true if the node connects, false otherwise
565 bool nodeboxConnects(MapNode from, MapNode to,
566 u8 connect_face) const;
569 * Registers a NodeResolver to wait for the registration of
570 * ContentFeatures. Once the node registration finishes, all
571 * listeners are notified.
573 void pendNodeResolve(NodeResolver *nr) const;
576 * Stops listening to the NodeDefManager.
577 * @return true if the listener was registered before, false otherwise
579 bool cancelNodeResolveCallback(NodeResolver *nr) const;
582 * Registers a new node type with the given name and allocates a new
584 * Should not be called with an already existing name.
585 * @param name name of the node, must match with `def.name`.
586 * @param def definition of the registered node type.
587 * @return ID of the registered node or @ref CONTENT_IGNORE if
588 * the function could not allocate an ID.
590 content_t set(const std::string &name, const ContentFeatures &def);
593 * Allocates a blank node ID for the given name.
594 * @param name name of a node
595 * @return allocated ID or @ref CONTENT_IGNORE if could not allocate
598 content_t allocateDummy(const std::string &name);
601 * Removes the given node name from the manager.
602 * The node ID will remain in the manager, but won't be linked to any name.
603 * @param name name to be removed
605 void removeNode(const std::string &name);
608 * Regenerates the alias list (a map from names to node IDs).
609 * @param idef the item definition manager containing alias information
611 void updateAliases(IItemDefManager *idef);
614 * Replaces the textures of registered nodes with the ones specified in
615 * the texturepack's override.txt file
617 * @param overrides the texture overrides
619 void applyTextureOverrides(const std::vector<TextureOverride> &overrides);
622 * Only the client uses this. Loads textures and shaders required for
623 * rendering the nodes.
624 * @param gamedef must be a Client.
625 * @param progress_cbk called each time a node is loaded. Arguments:
626 * `progress_cbk_args`, number of loaded ContentFeatures, number of
627 * total ContentFeatures.
628 * @param progress_cbk_args passed to the callback function
630 void updateTextures(IGameDef *gamedef,
631 void (*progress_cbk)(void *progress_args, u32 progress, u32 max_progress),
632 void *progress_cbk_args);
635 * Writes the content of this manager to the given output stream.
636 * @param protocol_version serialization version of ContentFeatures
638 void serialize(std::ostream &os, u16 protocol_version) const;
641 * Restores the manager from a serialized stream.
642 * This clears the previous state.
643 * @param is input stream containing a serialized NodeDefManager
645 void deSerialize(std::istream &is);
648 * Used to indicate that node registration has finished.
649 * @param completed tells whether registration is complete
651 inline void setNodeRegistrationStatus(bool completed) {
652 m_node_registration_complete = completed;
656 * Notifies the registered NodeResolver instances that node registration
657 * has finished, then unregisters all listeners.
658 * Must be called after node registration has finished!
660 void runNodeResolveCallbacks();
663 * Sets the registration completion flag to false and unregisters all
664 * NodeResolver instances listening to the manager.
666 void resetNodeResolveState();
669 * Resolves (caches the IDs) cross-references between nodes,
670 * like liquid alternatives.
671 * Must be called after node registration has finished!
673 void resolveCrossrefs();
677 * Resets the manager to its initial state.
678 * See the documentation of the constructor.
683 * Allocates a new content ID, and returns it.
684 * @return the allocated ID or \ref CONTENT_IGNORE if could not allocate
686 content_t allocateId();
689 * Binds the given content ID and node name.
690 * Registers them in \ref m_name_id_mapping and
691 * \ref m_name_id_mapping_with_aliases.
692 * @param i a content ID
693 * @param name a node name
695 void addNameIdMapping(content_t i, std::string name);
698 * Removes a content ID from all groups.
699 * Erases content IDs from vectors in \ref m_group_to_items and
700 * removes empty vectors.
701 * @param id Content ID
703 void eraseIdFromGroups(content_t id);
706 * Recalculates m_selection_box_int_union based on
707 * m_selection_box_union.
709 void fixSelectionBoxIntUnion();
711 //! Features indexed by ID.
712 std::vector<ContentFeatures> m_content_features;
714 //! A mapping for fast conversion between names and IDs
715 NameIdMapping m_name_id_mapping;
718 * Like @ref m_name_id_mapping, but maps only from names to IDs, and
719 * includes aliases too. Updated by \ref updateAliases().
720 * Note: Not serialized.
722 std::unordered_map<std::string, content_t> m_name_id_mapping_with_aliases;
725 * A mapping from group names to a vector of content types that belong
726 * to it. Necessary for a direct lookup in \ref getIds().
727 * Note: Not serialized.
729 std::unordered_map<std::string, std::vector<content_t>> m_group_to_items;
732 * The next ID that might be free to allocate.
733 * It can be allocated already, because \ref CONTENT_AIR,
734 * \ref CONTENT_UNKNOWN and \ref CONTENT_IGNORE are registered when the
735 * manager is initialized, and new IDs are allocated from 0.
739 //! True if all nodes have been registered.
740 bool m_node_registration_complete;
743 * The union of all nodes' selection boxes.
744 * Might be larger if big nodes are removed from the manager.
746 aabb3f m_selection_box_union;
749 * The smallest box in integer node coordinates that
750 * contains all nodes' selection boxes.
751 * Might be larger if big nodes are removed from the manager.
753 core::aabbox3d<s16> m_selection_box_int_union;
756 * NodeResolver instances to notify once node registration has finished.
757 * Even constant NodeDefManager instances can register listeners.
759 mutable std::vector<NodeResolver *> m_pending_resolve_callbacks;
762 NodeDefManager *createNodeDefManager();
767 virtual ~NodeResolver();
768 virtual void resolveNodeNames() = 0;
770 // required because this class is used as mixin for ObjDef
771 void cloneTo(NodeResolver *res) const;
773 bool getIdFromNrBacklog(content_t *result_out,
774 const std::string &node_alt, content_t c_fallback,
775 bool error_on_fallback = true);
776 bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
777 bool all_required = false, content_t c_fallback = CONTENT_IGNORE);
779 void nodeResolveInternal();
781 u32 m_nodenames_idx = 0;
782 u32 m_nnlistsizes_idx = 0;
783 std::vector<std::string> m_nodenames;
784 std::vector<size_t> m_nnlistsizes;
785 const NodeDefManager *m_ndef = nullptr;
786 bool m_resolve_done = false;