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