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 "tileanimation.h"
38 // PROTOCOL_VERSION >= 37
39 static const u8 CONTENTFEATURES_VERSION = 13;
41 class IItemDefManager;
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
66 // 2D rotation for things like plants
68 // Mesh options for plants
72 // 3 bits of palette index, then facedir
74 // 5 bits of palette index, then wallmounted
75 CPT2_COLORED_WALLMOUNTED,
76 // Glasslike framed drawtype internal liquid level, param2 values 0 to 63
77 CPT2_GLASSLIKE_LIQUID_LEVEL,
89 NODEBOX_REGULAR, // Regular block; allows buildable_to
90 NODEBOX_FIXED, // Static separately defined box(es)
91 NODEBOX_WALLMOUNTED, // Box for wall mounted nodes; (top, bottom, side)
92 NODEBOX_LEVELED, // Same as fixed, but with dynamic height from param2. for snow, ...
93 NODEBOX_CONNECTED, // optionally draws nodeboxes if a neighbor node attaches
98 enum NodeBoxType type;
99 // NODEBOX_REGULAR (no parameters)
101 std::vector<aabb3f> fixed;
102 // NODEBOX_WALLMOUNTED
105 aabb3f wall_side; // being at the -X side
107 std::vector<aabb3f> connect_top;
108 std::vector<aabb3f> connect_bottom;
109 std::vector<aabb3f> connect_front;
110 std::vector<aabb3f> connect_left;
111 std::vector<aabb3f> connect_back;
112 std::vector<aabb3f> connect_right;
113 std::vector<aabb3f> disconnected_top;
114 std::vector<aabb3f> disconnected_bottom;
115 std::vector<aabb3f> disconnected_front;
116 std::vector<aabb3f> disconnected_left;
117 std::vector<aabb3f> disconnected_back;
118 std::vector<aabb3f> disconnected_right;
119 std::vector<aabb3f> disconnected;
120 std::vector<aabb3f> disconnected_sides;
126 void serialize(std::ostream &os, u16 protocol_version) const;
127 void deSerialize(std::istream &is);
139 enum AutoScale : u8 {
145 enum WorldAlignMode : u8 {
149 WORLDALIGN_FORCE_NODEBOX,
152 class TextureSettings {
154 LeavesStyle leaves_style;
155 WorldAlignMode world_aligned_mode;
156 AutoScale autoscale_mode;
157 int node_texture_size;
159 bool connected_glass;
160 bool use_normal_texture;
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 #define CF_SPECIAL_COUNT 6
265 struct ContentFeatures
272 // up down right left back front
275 // - Currently used for flowing liquids
276 TileSpec special_tiles[CF_SPECIAL_COUNT];
277 u8 solidness; // Used when choosing which face is drawn
278 u8 visual_solidness; // When solidness=0, this tells how it looks like
279 bool backface_culling;
282 // Server-side cached callback existence for fast skipping
283 bool has_on_construct;
284 bool has_on_destruct;
285 bool has_after_destruct;
291 // --- GENERAL PROPERTIES ---
293 std::string name; // "" = undefined node
294 ItemGroupList groups; // Same as in itemdef
295 // Type of MapNode::param1
296 ContentParamType param_type;
297 // Type of MapNode::param2
298 ContentParamType2 param_type_2;
300 // --- VISUAL PROPERTIES ---
302 enum NodeDrawType drawtype;
305 scene::IMesh *mesh_ptr[24];
306 video::SColor minimap_color;
308 float visual_scale; // Misc. scale parameter
310 // These will be drawn over the base tiles.
311 TileDef tiledef_overlay[6];
312 TileDef tiledef_special[CF_SPECIAL_COUNT]; // eg. flowing liquid
313 // If 255, the node is opaque.
314 // Otherwise it uses texture alpha.
316 // The color of the node.
318 std::string palette_name;
319 std::vector<video::SColor> *palette;
320 // Used for waving leaves/plants
322 // for NDT_CONNECTED pairing
324 std::vector<std::string> connects_to;
325 std::vector<content_t> connects_to_ids;
326 // Post effect color, drawn when the camera is inside the node.
327 video::SColor post_effect_color;
328 // Flowing liquid or snow, value = default level
331 // --- LIGHTING-RELATED ---
333 bool light_propagates;
334 bool sunlight_propagates;
335 // Amount of light the node emits
338 // --- MAP GENERATION ---
340 // True for all ground-like things like stone and mud, false for eg. trees
341 bool is_ground_content;
343 // --- INTERACTION PROPERTIES ---
345 // This is used for collision detection.
346 // Also for general solidness queries.
348 // Player can point to these
350 // Player can dig these
352 // Player can climb these
354 // Player can build on these
356 // Player cannot build to these (placement prediction disabled)
358 u32 damage_per_second;
359 // client dig prediction
360 std::string node_dig_prediction;
362 // --- LIQUID PROPERTIES ---
364 // Whether the node is non-liquid, source liquid or flowing liquid
365 enum LiquidType liquid_type;
366 // If the content is liquid, this is the flowing version of the liquid.
367 std::string liquid_alternative_flowing;
368 // If the content is liquid, this is the source version of the liquid.
369 std::string liquid_alternative_source;
370 // Viscosity for fluid flow, ranging from 1 to 7, with
371 // 1 giving almost instantaneous propagation and 7 being
372 // the slowest possible
374 // Is liquid renewable (new liquid source will be created between 2 existing)
375 bool liquid_renewable;
376 // Number of flowing liquids surrounding source
379 // Liquids flow into and replace node
385 NodeBox selection_box;
386 NodeBox collision_box;
388 // --- SOUND PROPERTIES ---
390 SimpleSoundSpec sound_footstep;
391 SimpleSoundSpec sound_dig;
392 SimpleSoundSpec sound_dug;
396 // Compatibility with old maps
397 // Set to true if paramtype used to be 'facedir_simple'
398 bool legacy_facedir_simple;
399 // Set to true if wall_mounted used to be set to true
400 bool legacy_wallmounted;
407 ~ContentFeatures() = default;
409 void serialize(std::ostream &os, u16 protocol_version) const;
410 void deSerialize(std::istream &is);
412 * Since vertex alpha is no longer supported, this method
413 * adds opacity directly to the texture pixels.
415 * \param tiles array of the tile definitions.
416 * \param length length of tiles
418 void correctAlpha(TileDef *tiles, int length);
423 bool isLiquid() const{
424 return (liquid_type != LIQUID_NONE);
426 bool sameLiquid(const ContentFeatures &f) const{
427 if(!isLiquid() || !f.isLiquid()) return false;
428 return (liquid_alternative_flowing == f.liquid_alternative_flowing);
431 int getGroup(const std::string &group) const
433 return itemgroup_get(groups, group);
437 void updateTextures(ITextureSource *tsrc, IShaderSource *shdsrc,
438 scene::IMeshManipulator *meshmanip, Client *client, const TextureSettings &tsettings);
443 * @brief This class is for getting the actual properties of nodes from their
446 * @details The nodes on the map are represented by three numbers (see MapNode).
447 * The first number (param0) is the type of a node. All node types have own
448 * properties (see ContentFeatures). This class is for storing and getting the
449 * properties of nodes.
450 * The manager is first filled with registered nodes, then as the game begins,
451 * functions only get `const` pointers to it, to prevent modification of
454 class NodeDefManager {
457 * Creates a NodeDefManager, and registers three ContentFeatures:
458 * \ref CONTENT_AIR, \ref CONTENT_UNKNOWN and \ref CONTENT_IGNORE.
464 * Returns the properties for the given content type.
465 * @param c content type of a node
466 * @return properties of the given content type, or \ref CONTENT_UNKNOWN
467 * if the given content type is not registered.
469 inline const ContentFeatures& get(content_t c) const {
471 c < m_content_features.size() ?
472 m_content_features[c] : m_content_features[CONTENT_UNKNOWN];
476 * Returns the properties of the given node.
477 * @param n a map node
478 * @return properties of the given node or @ref CONTENT_UNKNOWN if the
479 * given content type is not registered.
481 inline const ContentFeatures& get(const MapNode &n) const {
482 return get(n.getContent());
486 * Returns the node properties for a node name.
487 * @param name name of a node
488 * @return properties of the given node or @ref CONTENT_UNKNOWN if
491 const ContentFeatures& get(const std::string &name) const;
494 * Returns the content ID for the given name.
495 * @param name a node name
496 * @param[out] result will contain the content ID if found, otherwise
498 * @return true if the ID was found, false otherwise
500 bool getId(const std::string &name, content_t &result) const;
503 * Returns the content ID for the given name.
504 * @param name a node name
505 * @return ID of the node or @ref CONTENT_IGNORE if not found
507 content_t getId(const std::string &name) const;
510 * Returns the content IDs of the given node name or node group name.
511 * Group names start with "group:".
512 * @param name a node name or node group name
513 * @param[out] result will be appended with matching IDs
514 * @return true if `name` is a valid node name or a (not necessarily
517 bool getIds(const std::string &name, std::vector<content_t> &result) const;
520 * Returns the smallest box in integer node coordinates that
521 * contains all nodes' selection boxes. The returned box might be larger
522 * than the minimal size if the largest node is removed from the manager.
524 inline core::aabbox3d<s16> getSelectionBoxIntUnion() const {
525 return m_selection_box_int_union;
529 * Checks whether a node connects to an adjacent node.
530 * @param from the node to be checked
531 * @param to the adjacent node
532 * @param connect_face a bit field indicating which face of the node is
533 * adjacent to the other node.
534 * Bits: +y (least significant), -y, -z, -x, +z, +x (most significant).
535 * @return true if the node connects, false otherwise
537 bool nodeboxConnects(MapNode from, MapNode to,
538 u8 connect_face) const;
541 * Registers a NodeResolver to wait for the registration of
542 * ContentFeatures. Once the node registration finishes, all
543 * listeners are notified.
545 void pendNodeResolve(NodeResolver *nr) const;
548 * Stops listening to the NodeDefManager.
549 * @return true if the listener was registered before, false otherwise
551 bool cancelNodeResolveCallback(NodeResolver *nr) const;
554 * Registers a new node type with the given name and allocates a new
556 * Should not be called with an already existing name.
557 * @param name name of the node, must match with `def.name`.
558 * @param def definition of the registered node type.
559 * @return ID of the registered node or @ref CONTENT_IGNORE if
560 * the function could not allocate an ID.
562 content_t set(const std::string &name, const ContentFeatures &def);
565 * Allocates a blank node ID for the given name.
566 * @param name name of a node
567 * @return allocated ID or @ref CONTENT_IGNORE if could not allocate
570 content_t allocateDummy(const std::string &name);
573 * Removes the given node name from the manager.
574 * The node ID will remain in the manager, but won't be linked to any name.
575 * @param name name to be removed
577 void removeNode(const std::string &name);
580 * Regenerates the alias list (a map from names to node IDs).
581 * @param idef the item definition manager containing alias information
583 void updateAliases(IItemDefManager *idef);
586 * Reads the used texture pack's override.txt, and replaces the textures
587 * of registered nodes with the ones specified there.
589 * Format of the input file: in each line
590 * `node_name top|bottom|right|left|front|back|all|*|sides texture_name.png`
592 * @param override_filepath path to 'texturepack/override.txt'
594 void applyTextureOverrides(const std::string &override_filepath);
597 * Only the client uses this. Loads textures and shaders required for
598 * rendering the nodes.
599 * @param gamedef must be a Client.
600 * @param progress_cbk called each time a node is loaded. Arguments:
601 * `progress_cbk_args`, number of loaded ContentFeatures, number of
602 * total ContentFeatures.
603 * @param progress_cbk_args passed to the callback function
605 void updateTextures(IGameDef *gamedef,
606 void (*progress_cbk)(void *progress_args, u32 progress, u32 max_progress),
607 void *progress_cbk_args);
610 * Writes the content of this manager to the given output stream.
611 * @param protocol_version serialization version of ContentFeatures
613 void serialize(std::ostream &os, u16 protocol_version) const;
616 * Restores the manager from a serialized stream.
617 * This clears the previous state.
618 * @param is input stream containing a serialized NodeDefManager
620 void deSerialize(std::istream &is);
623 * Used to indicate that node registration has finished.
624 * @param completed tells whether registration is complete
626 inline void setNodeRegistrationStatus(bool completed) {
627 m_node_registration_complete = completed;
631 * Notifies the registered NodeResolver instances that node registration
632 * has finished, then unregisters all listeners.
633 * Must be called after node registration has finished!
635 void runNodeResolveCallbacks();
638 * Sets the registration completion flag to false and unregisters all
639 * NodeResolver instances listening to the manager.
641 void resetNodeResolveState();
644 * Resolves the IDs to which connecting nodes connect from names.
645 * Must be called after node registration has finished!
647 void mapNodeboxConnections();
651 * Resets the manager to its initial state.
652 * See the documentation of the constructor.
657 * Allocates a new content ID, and returns it.
658 * @return the allocated ID or \ref CONTENT_IGNORE if could not allocate
660 content_t allocateId();
663 * Binds the given content ID and node name.
664 * Registers them in \ref m_name_id_mapping and
665 * \ref m_name_id_mapping_with_aliases.
666 * @param i a content ID
667 * @param name a node name
669 void addNameIdMapping(content_t i, std::string name);
672 * Recalculates m_selection_box_int_union based on
673 * m_selection_box_union.
675 void fixSelectionBoxIntUnion();
677 //! Features indexed by ID.
678 std::vector<ContentFeatures> m_content_features;
680 //! A mapping for fast conversion between names and IDs
681 NameIdMapping m_name_id_mapping;
684 * Like @ref m_name_id_mapping, but maps only from names to IDs, and
685 * includes aliases too. Updated by \ref updateAliases().
686 * Note: Not serialized.
688 std::unordered_map<std::string, content_t> m_name_id_mapping_with_aliases;
691 * A mapping from group names to a vector of content types that belong
692 * to it. Necessary for a direct lookup in \ref getIds().
693 * Note: Not serialized.
695 std::unordered_map<std::string, std::vector<content_t>> m_group_to_items;
698 * The next ID that might be free to allocate.
699 * It can be allocated already, because \ref CONTENT_AIR,
700 * \ref CONTENT_UNKNOWN and \ref CONTENT_IGNORE are registered when the
701 * manager is initialized, and new IDs are allocated from 0.
705 //! True if all nodes have been registered.
706 bool m_node_registration_complete;
709 * The union of all nodes' selection boxes.
710 * Might be larger if big nodes are removed from the manager.
712 aabb3f m_selection_box_union;
715 * The smallest box in integer node coordinates that
716 * contains all nodes' selection boxes.
717 * Might be larger if big nodes are removed from the manager.
719 core::aabbox3d<s16> m_selection_box_int_union;
722 * NodeResolver instances to notify once node registration has finished.
723 * Even constant NodeDefManager instances can register listeners.
725 mutable std::vector<NodeResolver *> m_pending_resolve_callbacks;
728 NodeDefManager *createNodeDefManager();
733 virtual ~NodeResolver();
734 virtual void resolveNodeNames() = 0;
736 bool getIdFromNrBacklog(content_t *result_out,
737 const std::string &node_alt, content_t c_fallback,
738 bool error_on_fallback = true);
739 bool getIdsFromNrBacklog(std::vector<content_t> *result_out,
740 bool all_required = false, content_t c_fallback = CONTENT_IGNORE);
742 void nodeResolveInternal();
744 u32 m_nodenames_idx = 0;
745 u32 m_nnlistsizes_idx = 0;
746 std::vector<std::string> m_nodenames;
747 std::vector<size_t> m_nnlistsizes;
748 const NodeDefManager *m_ndef = nullptr;
749 bool m_resolve_done = false;