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 "nodetimer.h"
35 #include "map_settings_manager.h"
42 class ServerMapSector;
46 class IRollbackManager;
48 class ServerEnvironment;
55 #define MAPTYPE_BASE 0
56 #define MAPTYPE_SERVER 1
57 #define MAPTYPE_CLIENT 2
59 enum MapEditEventType{
60 // Node added (changed from air or something else to something)
62 // Node removed (changed to air)
64 // Node swapped (changed without metadata change)
66 // Node metadata changed
67 MEET_BLOCK_NODE_METADATA_CHANGED,
68 // Anything else (modified_blocks are set unsent)
74 MapEditEventType type = MEET_OTHER;
76 MapNode n = CONTENT_AIR;
77 std::set<v3s16> modified_blocks;
78 bool is_private_change = false;
80 MapEditEvent() = default;
82 MapEditEvent * clone()
84 MapEditEvent *event = new MapEditEvent();
88 event->modified_blocks = modified_blocks;
89 event->is_private_change = is_private_change;
102 case MEET_BLOCK_NODE_METADATA_CHANGED:
104 v3s16 np1 = p*MAP_BLOCKSIZE;
105 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
106 return VoxelArea(np1, np2);
111 for (v3s16 p : modified_blocks) {
112 v3s16 np1 = p*MAP_BLOCKSIZE;
113 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
124 class MapEventReceiver
127 // event shall be deleted by caller after the call.
128 virtual void onMapEditEvent(MapEditEvent *event) = 0;
131 class Map /*: public NodeContainer*/
135 Map(std::ostream &dout, IGameDef *gamedef);
137 DISABLE_CLASS_COPY(Map);
139 virtual s32 mapType() const
145 Drop (client) or delete (server) the map.
152 void addEventReceiver(MapEventReceiver *event_receiver);
153 void removeEventReceiver(MapEventReceiver *event_receiver);
154 // event shall be deleted by caller after the call.
155 void dispatchEvent(MapEditEvent *event);
157 // On failure returns NULL
158 MapSector * getSectorNoGenerateNoLock(v2s16 p2d);
159 // Same as the above (there exists no lock anymore)
160 MapSector * getSectorNoGenerate(v2s16 p2d);
161 // Gets an existing sector or creates an empty one
162 //MapSector * getSectorCreate(v2s16 p2d);
165 This is overloaded by ClientMap and ServerMap to allow
166 their differing fetch methods.
168 virtual MapSector * emergeSector(v2s16 p){ return NULL; }
170 // Returns InvalidPositionException if not found
171 MapBlock * getBlockNoCreate(v3s16 p);
172 // Returns NULL if not found
173 MapBlock * getBlockNoCreateNoEx(v3s16 p);
175 /* Server overrides */
176 virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true)
177 { return getBlockNoCreateNoEx(p); }
179 inline const NodeDefManager * getNodeDefManager() { return m_nodedef; }
181 // Returns InvalidPositionException if not found
182 bool isNodeUnderground(v3s16 p);
184 bool isValidPosition(v3s16 p);
186 // throws InvalidPositionException if not found
187 void setNode(v3s16 p, MapNode & n);
189 // Returns a CONTENT_IGNORE node if not found
190 // If is_valid_position is not NULL then this will be set to true if the
191 // position is valid, otherwise false
192 MapNode getNode(v3s16 p, bool *is_valid_position = NULL);
195 These handle lighting but not faces.
197 void addNodeAndUpdate(v3s16 p, MapNode n,
198 std::map<v3s16, MapBlock*> &modified_blocks,
199 bool remove_metadata = true);
200 void removeNodeAndUpdate(v3s16 p,
201 std::map<v3s16, MapBlock*> &modified_blocks);
204 Wrappers for the latter ones.
206 Return true if succeeded, false if not.
208 bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
209 bool removeNodeWithEvent(v3s16 p);
211 // Call these before and after saving of many blocks
212 virtual void beginSave() {}
213 virtual void endSave() {}
215 virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); }
217 // Server implements these.
218 // Client leaves them as no-op.
219 virtual bool saveBlock(MapBlock *block) { return false; }
220 virtual bool deleteBlock(v3s16 blockpos) { return false; }
223 Updates usage timers and unloads unused blocks and sectors.
224 Saves modified blocks before unloading on MAPTYPE_SERVER.
226 void timerUpdate(float dtime, float unload_timeout, u32 max_loaded_blocks,
227 std::vector<v3s16> *unloaded_blocks=NULL);
230 Unloads all blocks with a zero refCount().
231 Saves modified blocks before unloading on MAPTYPE_SERVER.
233 void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
235 // Deletes sectors and their blocks from memory
236 // Takes cache into account
237 // If deleted sector is in sector cache, clears cache
238 void deleteSectors(std::vector<v2s16> &list);
240 // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
241 virtual void PrintInfo(std::ostream &out);
243 void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks,
244 ServerEnvironment *env);
248 These are basically coordinate wrappers to MapBlock
251 std::vector<v3s16> findNodesWithMetadata(v3s16 p1, v3s16 p2);
252 NodeMetadata *getNodeMetadata(v3s16 p);
255 * Sets metadata for a node.
256 * This method sets the metadata for a given node.
257 * On success, it returns @c true and the object pointed to
258 * by @p meta is then managed by the system and should
259 * not be deleted by the caller.
261 * In case of failure, the method returns @c false and the
262 * caller is still responsible for deleting the object!
264 * @param p node coordinates
265 * @param meta pointer to @c NodeMetadata object
266 * @return @c true on success, false on failure
268 bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
269 void removeNodeMetadata(v3s16 p);
273 These are basically coordinate wrappers to MapBlock
276 NodeTimer getNodeTimer(v3s16 p);
277 void setNodeTimer(const NodeTimer &t);
278 void removeNodeTimer(v3s16 p);
283 std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
289 void transforming_liquid_add(v3s16 p);
291 bool isBlockOccluded(MapBlock *block, v3s16 cam_pos_nodes);
293 friend class LuaVoxelManip;
295 std::ostream &m_dout; // A bit deprecated, could be removed
299 std::set<MapEventReceiver*> m_event_receivers;
301 std::map<v2s16, MapSector*> m_sectors;
303 // Be sure to set this to NULL when the cached sector is deleted
304 MapSector *m_sector_cache = nullptr;
305 v2s16 m_sector_cache_p;
307 // Queued transforming water nodes
308 UniqueQueue<v3s16> m_transforming_liquid;
310 // This stores the properties of the nodes on the map.
311 const NodeDefManager *m_nodedef;
313 bool determineAdditionalOcclusionCheck(const v3s16 &pos_camera,
314 const core::aabbox3d<s16> &block_bounds, v3s16 &check);
315 bool isOccluded(const v3s16 &pos_camera, const v3s16 &pos_target,
316 float step, float stepfac, float start_offset, float end_offset,
320 f32 m_transforming_liquid_loop_count_multiplier = 1.0f;
321 u32 m_unprocessed_count = 0;
322 u64 m_inc_trending_up_start_time = 0; // milliseconds
323 bool m_queue_size_timer_started = false;
329 This is the only map class that is able to generate map.
332 class ServerMap : public Map
336 savedir: directory to which map data should be saved
338 ServerMap(const std::string &savedir, IGameDef *gamedef, EmergeManager *emerge);
343 return MAPTYPE_SERVER;
347 Get a sector from somewhere.
349 - Check disk (doesn't load blocks)
352 MapSector *createSector(v2s16 p);
355 Blocks are generated by using these and makeBlock().
357 bool blockpos_over_mapgen_limit(v3s16 p);
358 bool initBlockMake(v3s16 blockpos, BlockMakeData *data);
359 void finishBlockMake(BlockMakeData *data,
360 std::map<v3s16, MapBlock*> *changed_blocks);
363 Get a block from somewhere.
367 MapBlock *createBlock(v3s16 p);
370 Forcefully get a block from somewhere.
373 - Create blank filled with CONTENT_IGNORE
376 MapBlock *emergeBlock(v3s16 p, bool create_blank=true);
380 If it does not exist in memory, add it to the emerge queue.
382 - Emerge Queue (deferred disk or generate)
384 MapBlock *getBlockOrEmerge(v3s16 p3d);
386 // Helper for placing objects on ground level
387 s16 findGroundLevel(v2s16 p2d);
390 Misc. helper functions for fiddling with directory and file
393 void createDirs(const std::string &path);
394 // returns something like "map/sectors/xxxxxxxx"
395 std::string getSectorDir(v2s16 pos, int layout = 2);
396 // dirname: final directory name
397 v2s16 getSectorPos(const std::string &dirname);
398 v3s16 getBlockPos(const std::string §ordir, const std::string &blockfile);
399 static std::string getBlockFilename(v3s16 p);
404 static MapDatabase *createDatabase(const std::string &name, const std::string &savedir, Settings &conf);
406 // Returns true if the database file does not exist
407 bool loadFromFolders();
409 // Call these before and after saving of blocks
413 void save(ModifiedState save_level);
414 void listAllLoadableBlocks(std::vector<v3s16> &dst);
415 void listAllLoadedBlocks(std::vector<v3s16> &dst);
417 MapgenParams *getMapgenParams();
419 bool saveBlock(MapBlock *block);
420 static bool saveBlock(MapBlock *block, MapDatabase *db);
421 // This will generate a sector with getSector if not found.
422 void loadBlock(const std::string §ordir, const std::string &blockfile,
423 MapSector *sector, bool save_after_load=false);
424 MapBlock* loadBlock(v3s16 p);
426 void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
428 bool deleteBlock(v3s16 blockpos);
430 void updateVManip(v3s16 pos);
432 // For debug printing
433 virtual void PrintInfo(std::ostream &out);
435 bool isSavingEnabled(){ return m_map_saving_enabled; }
441 * Fixes lighting in one map block.
442 * May modify other blocks as well, as light can spread
443 * out of the specified block.
444 * Returns false if the block is not generated (so nothing
445 * changed), true otherwise.
447 bool repairBlockLight(v3s16 blockpos,
448 std::map<v3s16, MapBlock *> *modified_blocks);
450 MapSettingsManager settings_mgr;
454 EmergeManager *m_emerge;
456 std::string m_savedir;
457 bool m_map_saving_enabled;
460 // Chunk size in MapSectors
461 // If 0, chunks are disabled.
464 core::map<v2s16, MapChunk*> m_chunks;
468 Metadata is re-written on disk only if this is true.
469 This is reset to false when written on disk.
471 bool m_map_metadata_changed = true;
472 MapDatabase *dbase = nullptr;
473 MapDatabase *dbase_ro = nullptr;
477 #define VMANIP_BLOCK_DATA_INEXIST 1
478 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2
480 class MMVManip : public VoxelManipulator
484 virtual ~MMVManip() = default;
488 VoxelManipulator::clear();
489 m_loaded_blocks.clear();
492 void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
493 bool load_if_inexistent = true);
495 // This is much faster with big chunks of generated data
496 void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
497 bool overwrite_generated = true);
499 bool m_is_dirty = false;
505 value = flags describing the block
507 std::map<v3s16, u8> m_loaded_blocks;