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.
29 #include "irrlichttypes_bloated.h"
31 #include "constants.h"
33 #include "modifiedstate.h"
34 #include "util/container.h"
35 #include "util/cpp11_container.h"
36 #include "nodetimer.h"
37 #include "map_settings_manager.h"
43 class ServerMapSector;
47 class IRollbackManager;
49 class ServerEnvironment;
56 #define MAPTYPE_BASE 0
57 #define MAPTYPE_SERVER 1
58 #define MAPTYPE_CLIENT 2
60 enum MapEditEventType{
61 // Node added (changed from air or something else to something)
63 // Node removed (changed to air)
65 // Node swapped (changed without metadata change)
67 // Node metadata of block changed (not knowing which node exactly)
68 // p stores block coordinate
69 MEET_BLOCK_NODE_METADATA_CHANGED,
70 // Anything else (modified_blocks are set unsent)
76 MapEditEventType type;
79 std::set<v3s16> modified_blocks;
80 u16 already_known_by_peer;
85 already_known_by_peer(0)
88 MapEditEvent * clone()
90 MapEditEvent *event = new MapEditEvent();
94 event->modified_blocks = modified_blocks;
103 case MEET_REMOVENODE:
107 case MEET_BLOCK_NODE_METADATA_CHANGED:
109 v3s16 np1 = p*MAP_BLOCKSIZE;
110 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
111 return VoxelArea(np1, np2);
116 for(std::set<v3s16>::iterator
117 i = modified_blocks.begin();
118 i != modified_blocks.end(); ++i)
121 v3s16 np1 = p*MAP_BLOCKSIZE;
122 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
133 class MapEventReceiver
136 // event shall be deleted by caller after the call.
137 virtual void onMapEditEvent(MapEditEvent *event) = 0;
140 class Map /*: public NodeContainer*/
144 Map(std::ostream &dout, IGameDef *gamedef);
147 /*virtual u16 nodeContainerId() const
149 return NODECONTAINER_ID_MAP;
152 virtual s32 mapType() const
158 Drop (client) or delete (server) the map.
165 void addEventReceiver(MapEventReceiver *event_receiver);
166 void removeEventReceiver(MapEventReceiver *event_receiver);
167 // event shall be deleted by caller after the call.
168 void dispatchEvent(MapEditEvent *event);
170 // On failure returns NULL
171 MapSector * getSectorNoGenerateNoExNoLock(v2s16 p2d);
172 // Same as the above (there exists no lock anymore)
173 MapSector * getSectorNoGenerateNoEx(v2s16 p2d);
174 // On failure throws InvalidPositionException
175 MapSector * getSectorNoGenerate(v2s16 p2d);
176 // Gets an existing sector or creates an empty one
177 //MapSector * getSectorCreate(v2s16 p2d);
180 This is overloaded by ClientMap and ServerMap to allow
181 their differing fetch methods.
183 virtual MapSector * emergeSector(v2s16 p){ return NULL; }
184 virtual MapSector * emergeSector(v2s16 p,
185 std::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
187 // Returns InvalidPositionException if not found
188 MapBlock * getBlockNoCreate(v3s16 p);
189 // Returns NULL if not found
190 MapBlock * getBlockNoCreateNoEx(v3s16 p);
192 /* Server overrides */
193 virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true)
194 { return getBlockNoCreateNoEx(p); }
196 inline INodeDefManager * getNodeDefManager() { return m_nodedef; }
198 // Returns InvalidPositionException if not found
199 bool isNodeUnderground(v3s16 p);
201 bool isValidPosition(v3s16 p);
203 // throws InvalidPositionException if not found
204 void setNode(v3s16 p, MapNode & n);
206 // Returns a CONTENT_IGNORE node if not found
207 // If is_valid_position is not NULL then this will be set to true if the
208 // position is valid, otherwise false
209 MapNode getNodeNoEx(v3s16 p, bool *is_valid_position = NULL);
211 void unspreadLight(enum LightBank bank,
212 std::map<v3s16, u8> & from_nodes,
213 std::set<v3s16> & light_sources,
214 std::map<v3s16, MapBlock*> & modified_blocks);
216 void spreadLight(enum LightBank bank,
217 std::set<v3s16> & from_nodes,
218 std::map<v3s16, MapBlock*> & modified_blocks);
220 void updateLighting(enum LightBank bank,
221 std::map<v3s16, MapBlock*> & a_blocks,
222 std::map<v3s16, MapBlock*> & modified_blocks);
224 void updateLighting(std::map<v3s16, MapBlock*> & a_blocks,
225 std::map<v3s16, MapBlock*> & modified_blocks);
228 These handle lighting but not faces.
230 void addNodeAndUpdate(v3s16 p, MapNode n,
231 std::map<v3s16, MapBlock*> &modified_blocks,
232 bool remove_metadata = true);
233 void removeNodeAndUpdate(v3s16 p,
234 std::map<v3s16, MapBlock*> &modified_blocks);
237 Wrappers for the latter ones.
239 Return true if succeeded, false if not.
241 bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
242 bool removeNodeWithEvent(v3s16 p);
245 Takes the blocks at the edges into account
247 bool getDayNightDiff(v3s16 blockpos);
249 //core::aabbox3d<s16> getDisplayedBlockArea();
251 //bool updateChangedVisibleArea();
253 // Call these before and after saving of many blocks
254 virtual void beginSave() { return; }
255 virtual void endSave() { return; }
257 virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); }
259 // Server implements these.
260 // Client leaves them as no-op.
261 virtual bool saveBlock(MapBlock *block) { return false; }
262 virtual bool deleteBlock(v3s16 blockpos) { return false; }
265 Updates usage timers and unloads unused blocks and sectors.
266 Saves modified blocks before unloading on MAPTYPE_SERVER.
268 void timerUpdate(float dtime, float unload_timeout, u32 max_loaded_blocks,
269 std::vector<v3s16> *unloaded_blocks=NULL);
272 Unloads all blocks with a zero refCount().
273 Saves modified blocks before unloading on MAPTYPE_SERVER.
275 void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
277 // Deletes sectors and their blocks from memory
278 // Takes cache into account
279 // If deleted sector is in sector cache, clears cache
280 void deleteSectors(std::vector<v2s16> &list);
282 // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
283 virtual void PrintInfo(std::ostream &out);
285 void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks);
289 These are basically coordinate wrappers to MapBlock
292 std::vector<v3s16> findNodesWithMetadata(v3s16 p1, v3s16 p2);
293 NodeMetadata *getNodeMetadata(v3s16 p);
296 * Sets metadata for a node.
297 * This method sets the metadata for a given node.
298 * On success, it returns @c true and the object pointed to
299 * by @p meta is then managed by the system and should
300 * not be deleted by the caller.
302 * In case of failure, the method returns @c false and the
303 * caller is still responsible for deleting the object!
305 * @param p node coordinates
306 * @param meta pointer to @c NodeMetadata object
307 * @return @c true on success, false on failure
309 bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
310 void removeNodeMetadata(v3s16 p);
314 These are basically coordinate wrappers to MapBlock
317 NodeTimer getNodeTimer(v3s16 p);
318 void setNodeTimer(const NodeTimer &t);
319 void removeNodeTimer(v3s16 p);
324 std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
330 void transforming_liquid_add(v3s16 p);
331 s32 transforming_liquid_size();
334 friend class LuaVoxelManip;
336 std::ostream &m_dout; // A bit deprecated, could be removed
340 std::set<MapEventReceiver*> m_event_receivers;
342 std::map<v2s16, MapSector*> m_sectors;
344 // Be sure to set this to NULL when the cached sector is deleted
345 MapSector *m_sector_cache;
346 v2s16 m_sector_cache_p;
348 // Queued transforming water nodes
349 UniqueQueue<v3s16> m_transforming_liquid;
351 // This stores the properties of the nodes on the map.
352 INodeDefManager *m_nodedef;
355 f32 m_transforming_liquid_loop_count_multiplier;
356 u32 m_unprocessed_count;
357 u32 m_inc_trending_up_start_time; // milliseconds
358 bool m_queue_size_timer_started;
360 DISABLE_CLASS_COPY(Map);
366 This is the only map class that is able to generate map.
369 class ServerMap : public Map
373 savedir: directory to which map data should be saved
375 ServerMap(std::string savedir, IGameDef *gamedef, EmergeManager *emerge);
380 return MAPTYPE_SERVER;
384 Get a sector from somewhere.
386 - Check disk (doesn't load blocks)
389 ServerMapSector *createSector(v2s16 p);
392 Blocks are generated by using these and makeBlock().
394 bool initBlockMake(v3s16 blockpos, BlockMakeData *data);
395 void finishBlockMake(BlockMakeData *data,
396 std::map<v3s16, MapBlock*> *changed_blocks);
399 Get a block from somewhere.
403 MapBlock *createBlock(v3s16 p);
406 Forcefully get a block from somewhere.
409 - Create blank filled with CONTENT_IGNORE
412 MapBlock *emergeBlock(v3s16 p, bool create_blank=true);
416 If it does not exist in memory, add it to the emerge queue.
418 - Emerge Queue (deferred disk or generate)
420 MapBlock *getBlockOrEmerge(v3s16 p3d);
422 // Carries out any initialization necessary before block is sent
423 void prepareBlock(MapBlock *block);
425 // Helper for placing objects on ground level
426 s16 findGroundLevel(v2s16 p2d);
429 Misc. helper functions for fiddling with directory and file
432 void createDirs(std::string path);
433 // returns something like "map/sectors/xxxxxxxx"
434 std::string getSectorDir(v2s16 pos, int layout = 2);
435 // dirname: final directory name
436 v2s16 getSectorPos(std::string dirname);
437 v3s16 getBlockPos(std::string sectordir, std::string blockfile);
438 static std::string getBlockFilename(v3s16 p);
443 static Database *createDatabase(const std::string &name, const std::string &savedir, Settings &conf);
444 // Verify we can read/write to the database
445 void verifyDatabase();
447 // Returns true if the database file does not exist
448 bool loadFromFolders();
450 // Call these before and after saving of blocks
454 void save(ModifiedState save_level);
455 void listAllLoadableBlocks(std::vector<v3s16> &dst);
456 void listAllLoadedBlocks(std::vector<v3s16> &dst);
458 MapgenParams *getMapgenParams();
460 /*void saveChunkMeta();
461 void loadChunkMeta();*/
463 // The sector mutex should be locked when calling most of these
465 // This only saves sector-specific data such as the heightmap
467 // DEPRECATED? Sectors have no metadata anymore.
468 void saveSectorMeta(ServerMapSector *sector);
469 MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
470 bool loadSectorMeta(v2s16 p2d);
472 // Full load of a sector including all blocks.
473 // returns true on success, false on failure.
474 bool loadSectorFull(v2s16 p2d);
475 // If sector is not found in memory, try to load it from disk.
476 // Returns true if sector now resides in memory
477 //bool deFlushSector(v2s16 p2d);
479 bool saveBlock(MapBlock *block);
480 static bool saveBlock(MapBlock *block, Database *db);
481 // This will generate a sector with getSector if not found.
482 void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector, bool save_after_load=false);
483 MapBlock* loadBlock(v3s16 p);
485 void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
487 bool deleteBlock(v3s16 blockpos);
489 void updateVManip(v3s16 pos);
491 // For debug printing
492 virtual void PrintInfo(std::ostream &out);
494 bool isSavingEnabled(){ return m_map_saving_enabled; }
499 MapSettingsManager settings_mgr;
503 EmergeManager *m_emerge;
505 std::string m_savedir;
506 bool m_map_saving_enabled;
509 // Chunk size in MapSectors
510 // If 0, chunks are disabled.
513 core::map<v2s16, MapChunk*> m_chunks;
517 Metadata is re-written on disk only if this is true.
518 This is reset to false when written on disk.
520 bool m_map_metadata_changed;
525 #define VMANIP_BLOCK_DATA_INEXIST 1
526 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2
528 class MMVManip : public VoxelManipulator
536 VoxelManipulator::clear();
537 m_loaded_blocks.clear();
540 void setMap(Map *map)
543 void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
544 bool load_if_inexistent = true);
546 // This is much faster with big chunks of generated data
547 void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
548 bool overwrite_generated = true);
557 value = flags describing the block
559 std::map<v3s16, u8> m_loaded_blocks;