3 Copyright (C) 2010-2011 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.
24 #include <jmutexautolock.h>
29 #include "irrlichttypes_bloated.h"
31 #include "constants.h"
33 #include "modifiedstate.h"
34 #include "util/container.h"
35 #include "nodetimer.h"
43 class ServerMapSector;
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 metadata of block changed (not knowing which node exactly)
66 // p stores block coordinate
67 MEET_BLOCK_NODE_METADATA_CHANGED,
68 // Anything else (modified_blocks are set unsent)
74 MapEditEventType type;
77 core::map<v3s16, bool> modified_blocks;
78 u16 already_known_by_peer;
82 already_known_by_peer(0)
86 MapEditEvent * clone()
88 MapEditEvent *event = new MapEditEvent();
92 for(core::map<v3s16, bool>::Iterator
93 i = modified_blocks.getIterator();
94 i.atEnd()==false; i++)
96 v3s16 p = i.getNode()->getKey();
97 bool v = i.getNode()->getValue();
98 event->modified_blocks.insert(p, v);
108 case MEET_REMOVENODE:
110 case MEET_BLOCK_NODE_METADATA_CHANGED:
112 v3s16 np1 = p*MAP_BLOCKSIZE;
113 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
114 return VoxelArea(np1, np2);
119 for(core::map<v3s16, bool>::Iterator
120 i = modified_blocks.getIterator();
121 i.atEnd()==false; i++)
123 v3s16 p = i.getNode()->getKey();
124 v3s16 np1 = p*MAP_BLOCKSIZE;
125 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
136 class MapEventReceiver
139 // event shall be deleted by caller after the call.
140 virtual void onMapEditEvent(MapEditEvent *event) = 0;
143 class Map /*: public NodeContainer*/
147 Map(std::ostream &dout, IGameDef *gamedef);
150 /*virtual u16 nodeContainerId() const
152 return NODECONTAINER_ID_MAP;
155 virtual s32 mapType() const
161 Drop (client) or delete (server) the map.
168 void addEventReceiver(MapEventReceiver *event_receiver);
169 void removeEventReceiver(MapEventReceiver *event_receiver);
170 // event shall be deleted by caller after the call.
171 void dispatchEvent(MapEditEvent *event);
173 // On failure returns NULL
174 MapSector * getSectorNoGenerateNoExNoLock(v2s16 p2d);
175 // Same as the above (there exists no lock anymore)
176 MapSector * getSectorNoGenerateNoEx(v2s16 p2d);
177 // On failure throws InvalidPositionException
178 MapSector * getSectorNoGenerate(v2s16 p2d);
179 // Gets an existing sector or creates an empty one
180 //MapSector * getSectorCreate(v2s16 p2d);
183 This is overloaded by ClientMap and ServerMap to allow
184 their differing fetch methods.
186 virtual MapSector * emergeSector(v2s16 p){ return NULL; }
187 virtual MapSector * emergeSector(v2s16 p,
188 core::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
190 // Returns InvalidPositionException if not found
191 MapBlock * getBlockNoCreate(v3s16 p);
192 // Returns NULL if not found
193 MapBlock * getBlockNoCreateNoEx(v3s16 p);
195 /* Server overrides */
196 virtual MapBlock * emergeBlock(v3s16 p, bool allow_generate=true)
197 { return getBlockNoCreateNoEx(p); }
199 // Returns InvalidPositionException if not found
200 bool isNodeUnderground(v3s16 p);
202 bool isValidPosition(v3s16 p);
204 // throws InvalidPositionException if not found
205 MapNode getNode(v3s16 p);
207 // throws InvalidPositionException if not found
208 void setNode(v3s16 p, MapNode & n);
210 // Returns a CONTENT_IGNORE node if not found
211 MapNode getNodeNoEx(v3s16 p);
213 void unspreadLight(enum LightBank bank,
214 core::map<v3s16, u8> & from_nodes,
215 core::map<v3s16, bool> & light_sources,
216 core::map<v3s16, MapBlock*> & modified_blocks);
218 void unLightNeighbors(enum LightBank bank,
219 v3s16 pos, u8 lightwas,
220 core::map<v3s16, bool> & light_sources,
221 core::map<v3s16, MapBlock*> & modified_blocks);
223 void spreadLight(enum LightBank bank,
224 core::map<v3s16, bool> & from_nodes,
225 core::map<v3s16, MapBlock*> & modified_blocks);
227 void lightNeighbors(enum LightBank bank,
229 core::map<v3s16, MapBlock*> & modified_blocks);
231 v3s16 getBrightestNeighbour(enum LightBank bank, v3s16 p);
233 s16 propagateSunlight(v3s16 start,
234 core::map<v3s16, MapBlock*> & modified_blocks);
236 void updateLighting(enum LightBank bank,
237 core::map<v3s16, MapBlock*> & a_blocks,
238 core::map<v3s16, MapBlock*> & modified_blocks);
240 void updateLighting(core::map<v3s16, MapBlock*> & a_blocks,
241 core::map<v3s16, MapBlock*> & modified_blocks);
244 These handle lighting but not faces.
246 void addNodeAndUpdate(v3s16 p, MapNode n,
247 core::map<v3s16, MapBlock*> &modified_blocks);
248 void removeNodeAndUpdate(v3s16 p,
249 core::map<v3s16, MapBlock*> &modified_blocks);
252 Wrappers for the latter ones.
254 Return true if succeeded, false if not.
256 bool addNodeWithEvent(v3s16 p, MapNode n);
257 bool removeNodeWithEvent(v3s16 p);
260 Takes the blocks at the edges into account
262 bool getDayNightDiff(v3s16 blockpos);
264 //core::aabbox3d<s16> getDisplayedBlockArea();
266 //bool updateChangedVisibleArea();
268 // Call these before and after saving of many blocks
269 virtual void beginSave() {return;};
270 virtual void endSave() {return;};
272 virtual void save(ModifiedState save_level){assert(0);};
274 // Server implements this.
275 // Client leaves it as no-op.
276 virtual void saveBlock(MapBlock *block){};
279 Updates usage timers and unloads unused blocks and sectors.
280 Saves modified blocks before unloading on MAPTYPE_SERVER.
282 void timerUpdate(float dtime, float unload_timeout,
283 core::list<v3s16> *unloaded_blocks=NULL);
285 // Deletes sectors and their blocks from memory
286 // Takes cache into account
287 // If deleted sector is in sector cache, clears cache
288 void deleteSectors(core::list<v2s16> &list);
293 = flush changed to disk and delete from memory, if usage timer of
294 block is more than timeout
296 void unloadUnusedData(float timeout,
297 core::list<v3s16> *deleted_blocks=NULL);
300 // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
301 virtual void PrintInfo(std::ostream &out);
303 void transformLiquids(core::map<v3s16, MapBlock*> & modified_blocks);
307 These are basically coordinate wrappers to MapBlock
310 NodeMetadata* getNodeMetadata(v3s16 p);
311 void setNodeMetadata(v3s16 p, NodeMetadata *meta);
312 void removeNodeMetadata(v3s16 p);
316 These are basically coordinate wrappers to MapBlock
319 NodeTimer getNodeTimer(v3s16 p);
320 void setNodeTimer(v3s16 p, NodeTimer t);
321 void removeNodeTimer(v3s16 p);
326 core::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
334 std::ostream &m_dout; // A bit deprecated, could be removed
338 core::map<MapEventReceiver*, bool> m_event_receivers;
340 core::map<v2s16, MapSector*> m_sectors;
342 // Be sure to set this to NULL when the cached sector is deleted
343 MapSector *m_sector_cache;
344 v2s16 m_sector_cache_p;
346 // Queued transforming water nodes
347 UniqueQueue<v3s16> m_transforming_liquid;
353 This is the only map class that is able to generate map.
356 class ServerMap : public Map
360 savedir: directory to which map data should be saved
362 ServerMap(std::string savedir, IGameDef *gamedef);
367 return MAPTYPE_SERVER;
371 Get a sector from somewhere.
373 - Check disk (doesn't load blocks)
376 ServerMapSector * createSector(v2s16 p);
379 Blocks are generated by using these and makeBlock().
381 void initBlockMake(mapgen::BlockMakeData *data, v3s16 blockpos);
382 MapBlock* finishBlockMake(mapgen::BlockMakeData *data,
383 core::map<v3s16, MapBlock*> &changed_blocks);
385 // A non-threaded wrapper to the above
386 MapBlock * generateBlock(
388 core::map<v3s16, MapBlock*> &modified_blocks
392 Get a block from somewhere.
396 MapBlock * createBlock(v3s16 p);
399 Forcefully get a block from somewhere.
404 MapBlock * emergeBlock(v3s16 p, bool allow_generate=true);
406 // Helper for placing objects on ground level
407 s16 findGroundLevel(v2s16 p2d);
410 Misc. helper functions for fiddling with directory and file
413 void createDirs(std::string path);
414 // returns something like "map/sectors/xxxxxxxx"
415 std::string getSectorDir(v2s16 pos, int layout = 2);
416 // dirname: final directory name
417 v2s16 getSectorPos(std::string dirname);
418 v3s16 getBlockPos(std::string sectordir, std::string blockfile);
419 static std::string getBlockFilename(v3s16 p);
424 // Create the database structure
425 void createDatabase();
426 // Verify we can read/write to the database
427 void verifyDatabase();
428 // Get an integer suitable for a block
429 static sqlite3_int64 getBlockAsInteger(const v3s16 pos);
430 static v3s16 getIntegerAsBlock(sqlite3_int64 i);
432 // Returns true if the database file does not exist
433 bool loadFromFolders();
435 // Call these before and after saving of blocks
439 void save(ModifiedState save_level);
442 void listAllLoadableBlocks(core::list<v3s16> &dst);
444 // Saves map seed and possibly other stuff
448 /*void saveChunkMeta();
449 void loadChunkMeta();*/
451 // The sector mutex should be locked when calling most of these
453 // This only saves sector-specific data such as the heightmap
455 // DEPRECATED? Sectors have no metadata anymore.
456 void saveSectorMeta(ServerMapSector *sector);
457 MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
458 bool loadSectorMeta(v2s16 p2d);
460 // Full load of a sector including all blocks.
461 // returns true on success, false on failure.
462 bool loadSectorFull(v2s16 p2d);
463 // If sector is not found in memory, try to load it from disk.
464 // Returns true if sector now resides in memory
465 //bool deFlushSector(v2s16 p2d);
467 void saveBlock(MapBlock *block);
468 // This will generate a sector with getSector if not found.
469 void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector, bool save_after_load=false);
470 MapBlock* loadBlock(v3s16 p);
472 void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
474 // For debug printing
475 virtual void PrintInfo(std::ostream &out);
477 bool isSavingEnabled(){ return m_map_saving_enabled; }
479 u64 getSeed(){ return m_seed; }
482 // Seed used for all kinds of randomness in generation
485 std::string m_savedir;
486 bool m_map_saving_enabled;
489 // Chunk size in MapSectors
490 // If 0, chunks are disabled.
493 core::map<v2s16, MapChunk*> m_chunks;
497 Metadata is re-written on disk only if this is true.
498 This is reset to false when written on disk.
500 bool m_map_metadata_changed;
503 SQLite database and statements
506 sqlite3_stmt *m_database_read;
507 sqlite3_stmt *m_database_write;
508 sqlite3_stmt *m_database_list;
511 class MapVoxelManipulator : public VoxelManipulator
514 MapVoxelManipulator(Map *map);
515 virtual ~MapVoxelManipulator();
519 VoxelManipulator::clear();
520 m_loaded_blocks.clear();
523 virtual void emerge(VoxelArea a, s32 caller_id=-1);
525 void blitBack(core::map<v3s16, MapBlock*> & modified_blocks);
531 value = block existed when loaded
533 core::map<v3s16, bool> m_loaded_blocks;
536 class ManualMapVoxelManipulator : public MapVoxelManipulator
539 ManualMapVoxelManipulator(Map *map);
540 virtual ~ManualMapVoxelManipulator();
542 void setMap(Map *map)
545 virtual void emerge(VoxelArea a, s32 caller_id=-1);
547 void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max);
549 // This is much faster with big chunks of generated data
550 void blitBackAll(core::map<v3s16, MapBlock*> * modified_blocks);