src/map.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #ifndef MAP_HEADER
  21 #define MAP_HEADER
  22
  23 #include <iostream>
  24 #include <sstream>
  25 #include <set>
  26 #include <map>
  27 #include <list>
  28
  29 #include "irrlichttypes_bloated.h"
  30 #include "mapnode.h"
  31 #include "constants.h"
  32 #include "voxel.h"
  33 #include "modifiedstate.h"
  34 #include "util/container.h"
  35 #include "nodetimer.h"
  36 #include "map_settings_manager.h"
  37
  38 class Settings;
  39 class MapDatabase;
  40 class ClientMap;
  41 class MapSector;
  42 class ServerMapSector;
  43 class MapBlock;
  44 class NodeMetadata;
  45 class IGameDef;
  46 class IRollbackManager;
  47 class EmergeManager;
  48 class ServerEnvironment;
  49 struct BlockMakeData;
  50
  51 /*
  52         MapEditEvent
  53 */
  54
  55 #define MAPTYPE_BASE 0
  56 #define MAPTYPE_SERVER 1
  57 #define MAPTYPE_CLIENT 2
  58
  59 enum MapEditEventType{
  60         // Node added (changed from air or something else to something)
  61         MEET_ADDNODE,
  62         // Node removed (changed to air)
  63         MEET_REMOVENODE,
  64         // Node swapped (changed without metadata change)
  65         MEET_SWAPNODE,
  66         // Node metadata of block changed (not knowing which node exactly)
  67         // p stores block coordinate
  68         MEET_BLOCK_NODE_METADATA_CHANGED,
  69         // Anything else (modified_blocks are set unsent)
  70         MEET_OTHER
  71 };
  72
  73 struct MapEditEvent
  74 {
  75         MapEditEventType type;
  76         v3s16 p;
  77         MapNode n;
  78         std::set<v3s16> modified_blocks;
  79         u16 already_known_by_peer;
  80
  81         MapEditEvent():
  82                 type(MEET_OTHER),
  83                 n(CONTENT_AIR),
  84                 already_known_by_peer(0)
  85         { }
  86
  87         MapEditEvent * clone()
  88         {
  89                 MapEditEvent *event = new MapEditEvent();
  90                 event->type = type;
  91                 event->p = p;
  92                 event->n = n;
  93                 event->modified_blocks = modified_blocks;
  94                 return event;
  95         }
  96
  97         VoxelArea getArea()
  98         {
  99                 switch(type){
 100                 case MEET_ADDNODE:
 101                         return VoxelArea(p);
 102                 case MEET_REMOVENODE:
 103                         return VoxelArea(p);
 104                 case MEET_SWAPNODE:
 105                         return VoxelArea(p);
 106                 case MEET_BLOCK_NODE_METADATA_CHANGED:
 107                 {
 108                         v3s16 np1 = p*MAP_BLOCKSIZE;
 109                         v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
 110                         return VoxelArea(np1, np2);
 111                 }
 112                 case MEET_OTHER:
 113                 {
 114                         VoxelArea a;
 115                         for(std::set<v3s16>::iterator
 116                                         i = modified_blocks.begin();
 117                                         i != modified_blocks.end(); ++i)
 118                         {
 119                                 v3s16 p = *i;
 120                                 v3s16 np1 = p*MAP_BLOCKSIZE;
 121                                 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
 122                                 a.addPoint(np1);
 123                                 a.addPoint(np2);
 124                         }
 125                         return a;
 126                 }
 127                 }
 128                 return VoxelArea();
 129         }
 130 };
 131
 132 class MapEventReceiver
 133 {
 134 public:
 135         // event shall be deleted by caller after the call.
 136         virtual void onMapEditEvent(MapEditEvent *event) = 0;
 137 };
 138
 139 class Map /*: public NodeContainer*/
 140 {
 141 public:
 142
 143         Map(std::ostream &dout, IGameDef *gamedef);
 144         virtual ~Map();
 145         DISABLE_CLASS_COPY(Map);
 146
 147         virtual s32 mapType() const
 148         {
 149                 return MAPTYPE_BASE;
 150         }
 151
 152         /*
 153                 Drop (client) or delete (server) the map.
 154         */
 155         virtual void drop()
 156         {
 157                 delete this;
 158         }
 159
 160         void addEventReceiver(MapEventReceiver *event_receiver);
 161         void removeEventReceiver(MapEventReceiver *event_receiver);
 162         // event shall be deleted by caller after the call.
 163         void dispatchEvent(MapEditEvent *event);
 164
 165         // On failure returns NULL
 166         MapSector * getSectorNoGenerateNoExNoLock(v2s16 p2d);
 167         // Same as the above (there exists no lock anymore)
 168         MapSector * getSectorNoGenerateNoEx(v2s16 p2d);
 169         // On failure throws InvalidPositionException
 170         MapSector * getSectorNoGenerate(v2s16 p2d);
 171         // Gets an existing sector or creates an empty one
 172         //MapSector * getSectorCreate(v2s16 p2d);
 173
 174         /*
 175                 This is overloaded by ClientMap and ServerMap to allow
 176                 their differing fetch methods.
 177         */
 178         virtual MapSector * emergeSector(v2s16 p){ return NULL; }
 179         virtual MapSector * emergeSector(v2s16 p,
 180                         std::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
 181
 182         // Returns InvalidPositionException if not found
 183         MapBlock * getBlockNoCreate(v3s16 p);
 184         // Returns NULL if not found
 185         MapBlock * getBlockNoCreateNoEx(v3s16 p);
 186
 187         /* Server overrides */
 188         virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true)
 189         { return getBlockNoCreateNoEx(p); }
 190
 191         inline INodeDefManager * getNodeDefManager() { return m_nodedef; }
 192
 193         // Returns InvalidPositionException if not found
 194         bool isNodeUnderground(v3s16 p);
 195
 196         bool isValidPosition(v3s16 p);
 197
 198         // throws InvalidPositionException if not found
 199         void setNode(v3s16 p, MapNode & n);
 200
 201         // Returns a CONTENT_IGNORE node if not found
 202         // If is_valid_position is not NULL then this will be set to true if the
 203         // position is valid, otherwise false
 204         MapNode getNodeNoEx(v3s16 p, bool *is_valid_position = NULL);
 205
 206         /*
 207                 These handle lighting but not faces.
 208         */
 209         void addNodeAndUpdate(v3s16 p, MapNode n,
 210                         std::map<v3s16, MapBlock*> &modified_blocks,
 211                         bool remove_metadata = true);
 212         void removeNodeAndUpdate(v3s16 p,
 213                         std::map<v3s16, MapBlock*> &modified_blocks);
 214
 215         /*
 216                 Wrappers for the latter ones.
 217                 These emit events.
 218                 Return true if succeeded, false if not.
 219         */
 220         bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
 221         bool removeNodeWithEvent(v3s16 p);
 222
 223         /*
 224                 Takes the blocks at the edges into account
 225         */
 226         bool getDayNightDiff(v3s16 blockpos);
 227
 228         //core::aabbox3d<s16> getDisplayedBlockArea();
 229
 230         //bool updateChangedVisibleArea();
 231
 232         // Call these before and after saving of many blocks
 233         virtual void beginSave() { return; }
 234         virtual void endSave() { return; }
 235
 236         virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); }
 237
 238         // Server implements these.
 239         // Client leaves them as no-op.
 240         virtual bool saveBlock(MapBlock *block) { return false; }
 241         virtual bool deleteBlock(v3s16 blockpos) { return false; }
 242
 243         /*
 244                 Updates usage timers and unloads unused blocks and sectors.
 245                 Saves modified blocks before unloading on MAPTYPE_SERVER.
 246         */
 247         void timerUpdate(float dtime, float unload_timeout, u32 max_loaded_blocks,
 248                         std::vector<v3s16> *unloaded_blocks=NULL);
 249
 250         /*
 251                 Unloads all blocks with a zero refCount().
 252                 Saves modified blocks before unloading on MAPTYPE_SERVER.
 253         */
 254         void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
 255
 256         // Deletes sectors and their blocks from memory
 257         // Takes cache into account
 258         // If deleted sector is in sector cache, clears cache
 259         void deleteSectors(std::vector<v2s16> &list);
 260
 261         // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
 262         virtual void PrintInfo(std::ostream &out);
 263
 264         void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks,
 265                         ServerEnvironment *env);
 266
 267         /*
 268                 Node metadata
 269                 These are basically coordinate wrappers to MapBlock
 270         */
 271
 272         std::vector<v3s16> findNodesWithMetadata(v3s16 p1, v3s16 p2);
 273         NodeMetadata *getNodeMetadata(v3s16 p);
 274
 275         /**
 276          * Sets metadata for a node.
 277          * This method sets the metadata for a given node.
 278          * On success, it returns @c true and the object pointed to
 279          * by @p meta is then managed by the system and should
 280          * not be deleted by the caller.
 281          *
 282          * In case of failure, the method returns @c false and the
 283          * caller is still responsible for deleting the object!
 284          *
 285          * @param p node coordinates
 286          * @param meta pointer to @c NodeMetadata object
 287          * @return @c true on success, false on failure
 288          */
 289         bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
 290         void removeNodeMetadata(v3s16 p);
 291
 292         /*
 293                 Node Timers
 294                 These are basically coordinate wrappers to MapBlock
 295         */
 296
 297         NodeTimer getNodeTimer(v3s16 p);
 298         void setNodeTimer(const NodeTimer &t);
 299         void removeNodeTimer(v3s16 p);
 300
 301         /*
 302                 Misc.
 303         */
 304         std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
 305
 306         /*
 307                 Variables
 308         */
 309
 310         void transforming_liquid_add(v3s16 p);
 311         s32 transforming_liquid_size();
 312
 313         bool isBlockOccluded(MapBlock *block, v3s16 cam_pos_nodes);
 314 protected:
 315         friend class LuaVoxelManip;
 316
 317         std::ostream &m_dout; // A bit deprecated, could be removed
 318
 319         IGameDef *m_gamedef;
 320
 321         std::set<MapEventReceiver*> m_event_receivers;
 322
 323         std::map<v2s16, MapSector*> m_sectors;
 324
 325         // Be sure to set this to NULL when the cached sector is deleted
 326         MapSector *m_sector_cache;
 327         v2s16 m_sector_cache_p;
 328
 329         // Queued transforming water nodes
 330         UniqueQueue<v3s16> m_transforming_liquid;
 331
 332         // This stores the properties of the nodes on the map.
 333         INodeDefManager *m_nodedef;
 334
 335         bool isOccluded(v3s16 p0, v3s16 p1, float step, float stepfac,
 336                         float start_off, float end_off, u32 needed_count);
 337
 338 private:
 339         f32 m_transforming_liquid_loop_count_multiplier;
 340         u32 m_unprocessed_count;
 341         u64 m_inc_trending_up_start_time; // milliseconds
 342         bool m_queue_size_timer_started;
 343 };
 344
 345 /*
 346         ServerMap
 347
 348         This is the only map class that is able to generate map.
 349 */
 350
 351 class ServerMap : public Map
 352 {
 353 public:
 354         /*
 355                 savedir: directory to which map data should be saved
 356         */
 357         ServerMap(const std::string &savedir, IGameDef *gamedef, EmergeManager *emerge);
 358         ~ServerMap();
 359
 360         s32 mapType() const
 361         {
 362                 return MAPTYPE_SERVER;
 363         }
 364
 365         /*
 366                 Get a sector from somewhere.
 367                 - Check memory
 368                 - Check disk (doesn't load blocks)
 369                 - Create blank one
 370         */
 371         ServerMapSector *createSector(v2s16 p);
 372
 373         bool saoPositionOverLimit(const v3f &p);
 374
 375         /*
 376                 Blocks are generated by using these and makeBlock().
 377         */
 378         bool blockpos_over_mapgen_limit(v3s16 p);
 379         bool initBlockMake(v3s16 blockpos, BlockMakeData *data);
 380         void finishBlockMake(BlockMakeData *data,
 381                 std::map<v3s16, MapBlock*> *changed_blocks);
 382
 383         /*
 384                 Get a block from somewhere.
 385                 - Memory
 386                 - Create blank
 387         */
 388         MapBlock *createBlock(v3s16 p);
 389
 390         /*
 391                 Forcefully get a block from somewhere.
 392                 - Memory
 393                 - Load from disk
 394                 - Create blank filled with CONTENT_IGNORE
 395
 396         */
 397         MapBlock *emergeBlock(v3s16 p, bool create_blank=true);
 398
 399         /*
 400                 Try to get a block.
 401                 If it does not exist in memory, add it to the emerge queue.
 402                 - Memory
 403                 - Emerge Queue (deferred disk or generate)
 404         */
 405         MapBlock *getBlockOrEmerge(v3s16 p3d);
 406
 407         // Helper for placing objects on ground level
 408         s16 findGroundLevel(v2s16 p2d);
 409
 410         /*
 411                 Misc. helper functions for fiddling with directory and file
 412                 names when saving
 413         */
 414         void createDirs(std::string path);
 415         // returns something like "map/sectors/xxxxxxxx"
 416         std::string getSectorDir(v2s16 pos, int layout = 2);
 417         // dirname: final directory name
 418         v2s16 getSectorPos(const std::string &dirname);
 419         v3s16 getBlockPos(const std::string &sectordir, const std::string &blockfile);
 420         static std::string getBlockFilename(v3s16 p);
 421
 422         /*
 423                 Database functions
 424         */
 425         static MapDatabase *createDatabase(const std::string &name, const std::string &savedir, Settings &conf);
 426
 427         // Returns true if the database file does not exist
 428         bool loadFromFolders();
 429
 430         // Call these before and after saving of blocks
 431         void beginSave();
 432         void endSave();
 433
 434         void save(ModifiedState save_level);
 435         void listAllLoadableBlocks(std::vector<v3s16> &dst);
 436         void listAllLoadedBlocks(std::vector<v3s16> &dst);
 437
 438         MapgenParams *getMapgenParams();
 439
 440         /*void saveChunkMeta();
 441         void loadChunkMeta();*/
 442
 443         // The sector mutex should be locked when calling most of these
 444
 445         // This only saves sector-specific data such as the heightmap
 446         // (no MapBlocks)
 447         // DEPRECATED? Sectors have no metadata anymore.
 448         void saveSectorMeta(ServerMapSector *sector);
 449         MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
 450         bool loadSectorMeta(v2s16 p2d);
 451
 452         bool saveBlock(MapBlock *block);
 453         static bool saveBlock(MapBlock *block, MapDatabase *db);
 454         // This will generate a sector with getSector if not found.
 455         void loadBlock(const std::string &sectordir, const std::string &blockfile,
 456                         MapSector *sector, bool save_after_load=false);
 457         MapBlock* loadBlock(v3s16 p);
 458         // Database version
 459         void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
 460
 461         bool deleteBlock(v3s16 blockpos);
 462
 463         void updateVManip(v3s16 pos);
 464
 465         // For debug printing
 466         virtual void PrintInfo(std::ostream &out);
 467
 468         bool isSavingEnabled(){ return m_map_saving_enabled; }
 469
 470         u64 getSeed();
 471         s16 getWaterLevel();
 472
 473         /*!
 474          * Fixes lighting in one map block.
 475          * May modify other blocks as well, as light can spread
 476          * out of the specified block.
 477          * Returns false if the block is not generated (so nothing
 478          * changed), true otherwise.
 479          */
 480         bool repairBlockLight(v3s16 blockpos,
 481                 std::map<v3s16, MapBlock *> *modified_blocks);
 482
 483         MapSettingsManager settings_mgr;
 484
 485 private:
 486         // Emerge manager
 487         EmergeManager *m_emerge;
 488
 489         std::string m_savedir;
 490         bool m_map_saving_enabled;
 491
 492 #if 0
 493         // Chunk size in MapSectors
 494         // If 0, chunks are disabled.
 495         s16 m_chunksize;
 496         // Chunks
 497         core::map<v2s16, MapChunk*> m_chunks;
 498 #endif
 499
 500         /*
 501                 Metadata is re-written on disk only if this is true.
 502                 This is reset to false when written on disk.
 503         */
 504         bool m_map_metadata_changed;
 505         MapDatabase *dbase;
 506 };
 507
 508
 509 #define VMANIP_BLOCK_DATA_INEXIST     1
 510 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2
 511
 512 class MMVManip : public VoxelManipulator
 513 {
 514 public:
 515         MMVManip(Map *map);
 516         virtual ~MMVManip();
 517
 518         virtual void clear()
 519         {
 520                 VoxelManipulator::clear();
 521                 m_loaded_blocks.clear();
 522         }
 523
 524         void setMap(Map *map)
 525         {m_map = map;}
 526
 527         void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
 528                 bool load_if_inexistent = true);
 529
 530         // This is much faster with big chunks of generated data
 531         void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
 532                 bool overwrite_generated = true);
 533
 534         bool m_is_dirty;
 535
 536 protected:
 537         bool m_create_area;
 538         Map *m_map;
 539         /*
 540                 key = blockpos
 541                 value = flags describing the block
 542         */
 543         std::map<v3s16, u8> m_loaded_blocks;
 544 };
 545
 546 #endif