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.
28 #include "irrlichttypes_bloated.h"
30 #include "constants.h"
32 #include "modifiedstate.h"
33 #include "util/container.h"
34 #include "util/metricsbackend.h"
35 #include "nodetimer.h"
36 #include "map_settings_manager.h"
43 class ServerMapSector;
47 class IRollbackManager;
50 class ServerEnvironment;
57 #define MAPTYPE_BASE 0
58 #define MAPTYPE_SERVER 1
59 #define MAPTYPE_CLIENT 2
61 enum MapEditEventType{
62 // Node added (changed from air or something else to something)
64 // Node removed (changed to air)
66 // Node swapped (changed without metadata change)
68 // Node metadata changed
69 MEET_BLOCK_NODE_METADATA_CHANGED,
70 // Anything else (modified_blocks are set unsent)
76 MapEditEventType type = MEET_OTHER;
78 MapNode n = CONTENT_AIR;
79 std::set<v3s16> modified_blocks;
80 bool is_private_change = false;
82 MapEditEvent() = default;
84 VoxelArea getArea() const
93 case MEET_BLOCK_NODE_METADATA_CHANGED:
95 v3s16 np1 = p*MAP_BLOCKSIZE;
96 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
97 return VoxelArea(np1, np2);
102 for (v3s16 p : modified_blocks) {
103 v3s16 np1 = p*MAP_BLOCKSIZE;
104 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
115 class MapEventReceiver
118 // event shall be deleted by caller after the call.
119 virtual void onMapEditEvent(const MapEditEvent &event) = 0;
122 class Map /*: public NodeContainer*/
126 Map(std::ostream &dout, IGameDef *gamedef);
128 DISABLE_CLASS_COPY(Map);
130 virtual s32 mapType() const
136 Drop (client) or delete (server) the map.
143 void addEventReceiver(MapEventReceiver *event_receiver);
144 void removeEventReceiver(MapEventReceiver *event_receiver);
145 // event shall be deleted by caller after the call.
146 void dispatchEvent(const MapEditEvent &event);
148 // On failure returns NULL
149 MapSector * getSectorNoGenerateNoLock(v2s16 p2d);
150 // Same as the above (there exists no lock anymore)
151 MapSector * getSectorNoGenerate(v2s16 p2d);
152 // Gets an existing sector or creates an empty one
153 //MapSector * getSectorCreate(v2s16 p2d);
156 This is overloaded by ClientMap and ServerMap to allow
157 their differing fetch methods.
159 virtual MapSector * emergeSector(v2s16 p){ return NULL; }
161 // Returns InvalidPositionException if not found
162 MapBlock * getBlockNoCreate(v3s16 p);
163 // Returns NULL if not found
164 MapBlock * getBlockNoCreateNoEx(v3s16 p);
166 /* Server overrides */
167 virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true)
168 { return getBlockNoCreateNoEx(p); }
170 inline const NodeDefManager * getNodeDefManager() { return m_nodedef; }
172 // Returns InvalidPositionException if not found
173 bool isNodeUnderground(v3s16 p);
175 bool isValidPosition(v3s16 p);
177 // throws InvalidPositionException if not found
178 void setNode(v3s16 p, MapNode & n);
180 // Returns a CONTENT_IGNORE node if not found
181 // If is_valid_position is not NULL then this will be set to true if the
182 // position is valid, otherwise false
183 MapNode getNode(v3s16 p, bool *is_valid_position = NULL);
186 These handle lighting but not faces.
188 void addNodeAndUpdate(v3s16 p, MapNode n,
189 std::map<v3s16, MapBlock*> &modified_blocks,
190 bool remove_metadata = true);
191 void removeNodeAndUpdate(v3s16 p,
192 std::map<v3s16, MapBlock*> &modified_blocks);
195 Wrappers for the latter ones.
197 Return true if succeeded, false if not.
199 bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
200 bool removeNodeWithEvent(v3s16 p);
202 // Call these before and after saving of many blocks
203 virtual void beginSave() {}
204 virtual void endSave() {}
206 virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); }
208 // Server implements these.
209 // Client leaves them as no-op.
210 virtual bool saveBlock(MapBlock *block) { return false; }
211 virtual bool deleteBlock(v3s16 blockpos) { return false; }
214 Updates usage timers and unloads unused blocks and sectors.
215 Saves modified blocks before unloading on MAPTYPE_SERVER.
217 void timerUpdate(float dtime, float unload_timeout, u32 max_loaded_blocks,
218 std::vector<v3s16> *unloaded_blocks=NULL);
221 Unloads all blocks with a zero refCount().
222 Saves modified blocks before unloading on MAPTYPE_SERVER.
224 void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
226 // Deletes sectors and their blocks from memory
227 // Takes cache into account
228 // If deleted sector is in sector cache, clears cache
229 void deleteSectors(std::vector<v2s16> &list);
231 // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
232 virtual void PrintInfo(std::ostream &out);
234 void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks,
235 ServerEnvironment *env);
239 These are basically coordinate wrappers to MapBlock
242 std::vector<v3s16> findNodesWithMetadata(v3s16 p1, v3s16 p2);
243 NodeMetadata *getNodeMetadata(v3s16 p);
246 * Sets metadata for a node.
247 * This method sets the metadata for a given node.
248 * On success, it returns @c true and the object pointed to
249 * by @p meta is then managed by the system and should
250 * not be deleted by the caller.
252 * In case of failure, the method returns @c false and the
253 * caller is still responsible for deleting the object!
255 * @param p node coordinates
256 * @param meta pointer to @c NodeMetadata object
257 * @return @c true on success, false on failure
259 bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
260 void removeNodeMetadata(v3s16 p);
264 These are basically coordinate wrappers to MapBlock
267 NodeTimer getNodeTimer(v3s16 p);
268 void setNodeTimer(const NodeTimer &t);
269 void removeNodeTimer(v3s16 p);
274 std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
280 void transforming_liquid_add(v3s16 p);
282 bool isBlockOccluded(MapBlock *block, v3s16 cam_pos_nodes);
284 friend class LuaVoxelManip;
286 std::ostream &m_dout; // A bit deprecated, could be removed
290 std::set<MapEventReceiver*> m_event_receivers;
292 std::map<v2s16, MapSector*> m_sectors;
294 // Be sure to set this to NULL when the cached sector is deleted
295 MapSector *m_sector_cache = nullptr;
296 v2s16 m_sector_cache_p;
298 // Queued transforming water nodes
299 UniqueQueue<v3s16> m_transforming_liquid;
301 // This stores the properties of the nodes on the map.
302 const NodeDefManager *m_nodedef;
304 bool determineAdditionalOcclusionCheck(const v3s16 &pos_camera,
305 const core::aabbox3d<s16> &block_bounds, v3s16 &check);
306 bool isOccluded(const v3s16 &pos_camera, const v3s16 &pos_target,
307 float step, float stepfac, float start_offset, float end_offset,
311 f32 m_transforming_liquid_loop_count_multiplier = 1.0f;
312 u32 m_unprocessed_count = 0;
313 u64 m_inc_trending_up_start_time = 0; // milliseconds
314 bool m_queue_size_timer_started = false;
320 This is the only map class that is able to generate map.
323 class ServerMap : public Map
327 savedir: directory to which map data should be saved
329 ServerMap(const std::string &savedir, IGameDef *gamedef, EmergeManager *emerge, MetricsBackend *mb);
334 return MAPTYPE_SERVER;
338 Get a sector from somewhere.
340 - Check disk (doesn't load blocks)
343 MapSector *createSector(v2s16 p);
346 Blocks are generated by using these and makeBlock().
348 bool blockpos_over_mapgen_limit(v3s16 p);
349 bool initBlockMake(v3s16 blockpos, BlockMakeData *data);
350 void finishBlockMake(BlockMakeData *data,
351 std::map<v3s16, MapBlock*> *changed_blocks);
354 Get a block from somewhere.
358 MapBlock *createBlock(v3s16 p);
361 Forcefully get a block from somewhere.
364 - Create blank filled with CONTENT_IGNORE
367 MapBlock *emergeBlock(v3s16 p, bool create_blank=true);
371 If it does not exist in memory, add it to the emerge queue.
373 - Emerge Queue (deferred disk or generate)
375 MapBlock *getBlockOrEmerge(v3s16 p3d);
377 // Helper for placing objects on ground level
378 s16 findGroundLevel(v2s16 p2d);
381 Misc. helper functions for fiddling with directory and file
384 void createDirs(const std::string &path);
389 static MapDatabase *createDatabase(const std::string &name, const std::string &savedir, Settings &conf);
392 // Call these before and after saving of blocks
396 void save(ModifiedState save_level);
397 void listAllLoadableBlocks(std::vector<v3s16> &dst);
398 void listAllLoadedBlocks(std::vector<v3s16> &dst);
400 MapgenParams *getMapgenParams();
402 bool saveBlock(MapBlock *block);
403 static bool saveBlock(MapBlock *block, MapDatabase *db);
404 MapBlock* loadBlock(v3s16 p);
406 void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
408 bool deleteBlock(v3s16 blockpos);
410 void updateVManip(v3s16 pos);
412 // For debug printing
413 virtual void PrintInfo(std::ostream &out);
415 bool isSavingEnabled(){ return m_map_saving_enabled; }
421 * Fixes lighting in one map block.
422 * May modify other blocks as well, as light can spread
423 * out of the specified block.
424 * Returns false if the block is not generated (so nothing
425 * changed), true otherwise.
427 bool repairBlockLight(v3s16 blockpos,
428 std::map<v3s16, MapBlock *> *modified_blocks);
430 MapSettingsManager settings_mgr;
434 EmergeManager *m_emerge;
436 std::string m_savedir;
437 bool m_map_saving_enabled;
440 // Chunk size in MapSectors
441 // If 0, chunks are disabled.
444 core::map<v2s16, MapChunk*> m_chunks;
448 Metadata is re-written on disk only if this is true.
449 This is reset to false when written on disk.
451 bool m_map_metadata_changed = true;
452 MapDatabase *dbase = nullptr;
453 MapDatabase *dbase_ro = nullptr;
455 MetricCounterPtr m_save_time_counter;
459 #define VMANIP_BLOCK_DATA_INEXIST 1
460 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2
462 class MMVManip : public VoxelManipulator
466 virtual ~MMVManip() = default;
470 VoxelManipulator::clear();
471 m_loaded_blocks.clear();
474 void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
475 bool load_if_inexistent = true);
477 // This is much faster with big chunks of generated data
478 void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
479 bool overwrite_generated = true);
481 bool m_is_dirty = false;
487 value = flags describing the block
489 std::map<v3s16, u8> m_loaded_blocks;