3 Copyright (C) 2010 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 General Public License as published by
7 the Free Software Foundation; either version 2 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 General Public License for more details.
15 You should have received a copy of the GNU 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 #define sleep_s(x) Sleep((x*1000))
32 #define sleep_s(x) sleep(x)
35 #include "common_irrlicht.h"
38 #include "mapsector.h"
39 #include "constants.h"
42 #include "nodemetadata.h"
44 #define MAPTYPE_BASE 0
45 #define MAPTYPE_SERVER 1
46 #define MAPTYPE_CLIENT 2
48 enum MapEditEventType{
56 MapEditEventType type;
59 core::map<v3s16, bool> modified_blocks;
60 u16 already_known_by_peer;
64 already_known_by_peer(0)
68 MapEditEvent * clone()
70 MapEditEvent *event = new MapEditEvent();
74 for(core::map<v3s16, bool>::Iterator
75 i = modified_blocks.getIterator();
76 i.atEnd()==false; i++)
78 v3s16 p = i.getNode()->getKey();
79 bool v = i.getNode()->getValue();
80 event->modified_blocks.insert(p, v);
86 class MapEventReceiver
89 // event shall be deleted by caller after the call.
90 virtual void onMapEditEvent(MapEditEvent *event) = 0;
93 class Map : public NodeContainer
97 Map(std::ostream &dout);
100 virtual u16 nodeContainerId() const
102 return NODECONTAINER_ID_MAP;
105 virtual s32 mapType() const
111 Drop (client) or delete (server) the map.
118 void addEventReceiver(MapEventReceiver *event_receiver);
119 void removeEventReceiver(MapEventReceiver *event_receiver);
120 // event shall be deleted by caller after the call.
121 void dispatchEvent(MapEditEvent *event);
123 // On failure returns NULL
124 MapSector * getSectorNoGenerateNoExNoLock(v2s16 p2d);
125 // On failure returns NULL
126 MapSector * getSectorNoGenerateNoEx(v2s16 p2d);
127 // On failure throws InvalidPositionException
128 MapSector * getSectorNoGenerate(v2s16 p2d);
129 // Gets an existing sector or creates an empty one
130 //MapSector * getSectorCreate(v2s16 p2d);
133 This is overloaded by ClientMap and ServerMap to allow
134 their differing fetch methods.
136 virtual MapSector * emergeSector(v2s16 p){ return NULL; }
137 virtual MapSector * emergeSector(v2s16 p,
138 core::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
140 // Returns InvalidPositionException if not found
141 MapBlock * getBlockNoCreate(v3s16 p);
142 // Returns NULL if not found
143 MapBlock * getBlockNoCreateNoEx(v3s16 p);
144 // Gets an existing block or creates an empty one
145 //MapBlock * getBlockCreate(v3s16 p);
147 // Returns InvalidPositionException if not found
148 bool isNodeUnderground(v3s16 p);
150 // virtual from NodeContainer
151 bool isValidPosition(v3s16 p)
153 v3s16 blockpos = getNodeBlockPos(p);
156 blockref = getBlockNoCreate(blockpos);
158 catch(InvalidPositionException &e)
163 /*v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
164 bool is_valid = blockref->isValidPosition(relpos);
168 // virtual from NodeContainer
169 // throws InvalidPositionException if not found
170 MapNode getNode(v3s16 p)
172 v3s16 blockpos = getNodeBlockPos(p);
173 MapBlock * blockref = getBlockNoCreate(blockpos);
174 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
176 return blockref->getNodeNoCheck(relpos);
179 // virtual from NodeContainer
180 // throws InvalidPositionException if not found
181 void setNode(v3s16 p, MapNode & n)
183 v3s16 blockpos = getNodeBlockPos(p);
184 MapBlock * blockref = getBlockNoCreate(blockpos);
185 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
186 blockref->setNodeNoCheck(relpos, n);
189 // Returns a CONTENT_IGNORE node if not found
190 MapNode getNodeNoEx(v3s16 p)
193 v3s16 blockpos = getNodeBlockPos(p);
194 MapBlock * blockref = getBlockNoCreate(blockpos);
195 v3s16 relpos = p - blockpos*MAP_BLOCKSIZE;
197 return blockref->getNodeNoCheck(relpos);
199 catch(InvalidPositionException &e)
201 return MapNode(CONTENT_IGNORE);
205 void unspreadLight(enum LightBank bank,
206 core::map<v3s16, u8> & from_nodes,
207 core::map<v3s16, bool> & light_sources,
208 core::map<v3s16, MapBlock*> & modified_blocks);
210 void unLightNeighbors(enum LightBank bank,
211 v3s16 pos, u8 lightwas,
212 core::map<v3s16, bool> & light_sources,
213 core::map<v3s16, MapBlock*> & modified_blocks);
215 void spreadLight(enum LightBank bank,
216 core::map<v3s16, bool> & from_nodes,
217 core::map<v3s16, MapBlock*> & modified_blocks);
219 void lightNeighbors(enum LightBank bank,
221 core::map<v3s16, MapBlock*> & modified_blocks);
223 v3s16 getBrightestNeighbour(enum LightBank bank, v3s16 p);
225 s16 propagateSunlight(v3s16 start,
226 core::map<v3s16, MapBlock*> & modified_blocks);
228 void updateLighting(enum LightBank bank,
229 core::map<v3s16, MapBlock*> & a_blocks,
230 core::map<v3s16, MapBlock*> & modified_blocks);
232 void updateLighting(core::map<v3s16, MapBlock*> & a_blocks,
233 core::map<v3s16, MapBlock*> & modified_blocks);
236 These handle lighting but not faces.
238 void addNodeAndUpdate(v3s16 p, MapNode n,
239 core::map<v3s16, MapBlock*> &modified_blocks);
240 void removeNodeAndUpdate(v3s16 p,
241 core::map<v3s16, MapBlock*> &modified_blocks);
244 Wrappers for the latter ones.
246 Return true if succeeded, false if not.
248 bool addNodeWithEvent(v3s16 p, MapNode n);
249 bool removeNodeWithEvent(v3s16 p);
252 Takes the blocks at the edges into account
254 bool dayNightDiffed(v3s16 blockpos);
256 //core::aabbox3d<s16> getDisplayedBlockArea();
258 //bool updateChangedVisibleArea();
260 virtual void save(bool only_changed){assert(0);};
265 void timerUpdate(float dtime);
267 // Takes cache into account
268 // sector mutex should be locked when calling
269 void deleteSectors(core::list<v2s16> &list, bool only_blocks);
271 // Returns count of deleted sectors
272 u32 deleteUnusedSectors(float timeout, bool only_blocks=false,
273 core::list<v3s16> *deleted_blocks=NULL);
275 // For debug printing
276 virtual void PrintInfo(std::ostream &out);
278 void transformLiquids(core::map<v3s16, MapBlock*> & modified_blocks);
282 These are basically coordinate wrappers to MapBlock
285 NodeMetadata* getNodeMetadata(v3s16 p);
286 void setNodeMetadata(v3s16 p, NodeMetadata *meta);
287 void removeNodeMetadata(v3s16 p);
288 void nodeMetadataStep(float dtime,
289 core::map<v3s16, MapBlock*> &changed_blocks);
297 std::ostream &m_dout;
299 core::map<MapEventReceiver*, bool> m_event_receivers;
301 // Mutex is important because on client map is accessed asynchronously
302 core::map<v2s16, MapSector*> m_sectors;
303 JMutex m_sector_mutex;
305 // Be sure to set this to NULL when the cached sector is deleted
306 MapSector *m_sector_cache;
307 v2s16 m_sector_cache_p;
309 //WrapperHeightmap m_hwrapper;
311 // Queued transforming water nodes
312 UniqueQueue<v3s16> m_transforming_liquid;
318 This is the only map class that is able to generate map.
321 struct ChunkMakeData;
323 class ServerMap : public Map
327 savedir: directory to which map data should be saved
329 ServerMap(std::string savedir);
334 return MAPTYPE_SERVER;
341 // Returns the position of the chunk where the sector is in
342 v2s16 sector_to_chunk(v2s16 sectorpos)
344 sectorpos.X += m_chunksize / 2;
345 sectorpos.Y += m_chunksize / 2;
346 v2s16 chunkpos = getContainerPos(sectorpos, m_chunksize);
350 // Returns the position of the (0,0) sector of the chunk
351 v2s16 chunk_to_sector(v2s16 chunkpos)
354 chunkpos.X * m_chunksize,
355 chunkpos.Y * m_chunksize
357 sectorpos.X -= m_chunksize / 2;
358 sectorpos.Y -= m_chunksize / 2;
365 MapChunk *getChunk(v2s16 chunkpos)
367 core::map<v2s16, MapChunk*>::Node *n;
368 n = m_chunks.find(chunkpos);
371 return n->getValue();
375 True if the chunk and its neighbors are fully generated.
376 It means the chunk will not be touched in the future by the
377 generator. If false, generateChunk will make it true.
379 bool chunkNonVolatile(v2s16 chunkpos)
381 /*for(s16 x=-1; x<=1; x++)
382 for(s16 y=-1; y<=1; y++)*/
386 v2s16 chunkpos0 = chunkpos + v2s16(x,y);
387 MapChunk *chunk = getChunk(chunkpos);
390 if(chunk->getGenLevel() != GENERATED_FULLY)
396 void initChunkMake(ChunkMakeData &data, v2s16 chunkpos);
397 MapChunk* finishChunkMake(ChunkMakeData &data,
398 core::map<v3s16, MapBlock*> &changed_blocks);
403 All chunks touching this one can be altered also.
405 MapChunk* generateChunkRaw(v2s16 chunkpos,
406 core::map<v3s16, MapBlock*> &changed_blocks,
410 Generate a chunk and its neighbors so that it won't be touched
413 MapChunk* generateChunk(v2s16 chunkpos,
414 core::map<v3s16, MapBlock*> &changed_blocks);
419 This is mainly called by generateChunkRaw.
421 //ServerMapSector * generateSector(v2s16 p);
424 Get a sector from somewhere.
426 - Check disk (loads blocks also)
429 ServerMapSector * createSector(v2s16 p);
432 Get a sector from somewhere.
434 - Check disk (loads blocks also)
437 MapSector * emergeSector(v2s16 p,
438 core::map<v3s16, MapBlock*> &changed_blocks);
440 MapSector * emergeSector(v2s16 p)
442 core::map<v3s16, MapBlock*> changed_blocks;
443 return emergeSector(p, changed_blocks);
446 MapBlock * generateBlock(
448 MapBlock *original_dummy,
449 ServerMapSector *sector,
450 core::map<v3s16, MapBlock*> &changed_blocks,
451 core::map<v3s16, MapBlock*> &lighting_invalidated_blocks
455 Get a block from somewhere.
459 MapBlock * createBlock(v3s16 p);
462 only_from_disk, changed_blocks and lighting_invalidated_blocks
463 are not properly used by the new map generator.
465 MapBlock * emergeBlock(
468 core::map<v3s16, MapBlock*> &changed_blocks,
469 core::map<v3s16, MapBlock*> &lighting_invalidated_blocks
474 Forcefully get a block from somewhere.
477 - InvalidPositionException: possible if only_from_disk==true
480 - All already existing blocks that were modified are added.
481 - If found on disk, nothing will be added.
482 - If generated, the new block will not be included.
484 lighting_invalidated_blocks:
485 - All blocks that have heavy-to-calculate lighting changes
487 - updateLighting() should be called for these.
489 - A block that is in changed_blocks may not be in
490 lighting_invalidated_blocks.
492 MapBlock * emergeBlock(
495 core::map<v3s16, MapBlock*> &changed_blocks,
496 core::map<v3s16, MapBlock*> &lighting_invalidated_blocks
500 // Helper for placing objects on ground level
501 s16 findGroundLevel(v2s16 p2d);
504 Misc. helper functions for fiddling with directory and file
507 void createDir(std::string path);
508 void createSaveDir();
509 // returns something like "xxxxxxxx"
510 std::string getSectorSubDir(v2s16 pos);
511 // returns something like "map/sectors/xxxxxxxx"
512 std::string getSectorDir(v2s16 pos);
513 std::string createSectorDir(v2s16 pos);
514 // dirname: final directory name
515 v2s16 getSectorPos(std::string dirname);
516 v3s16 getBlockPos(std::string sectordir, std::string blockfile);
518 void save(bool only_changed);
521 // Saves map seed and possibly other stuff
525 void saveChunkMeta();
526 void loadChunkMeta();
528 // The sector mutex should be locked when calling most of these
530 // This only saves sector-specific data such as the heightmap
532 // DEPRECATED? Sectors have no metadata anymore.
533 void saveSectorMeta(ServerMapSector *sector);
534 MapSector* loadSectorMeta(std::string dirname);
536 // Full load of a sector including all blocks.
537 // returns true on success, false on failure.
538 bool loadSectorFull(v2s16 p2d);
539 // If sector is not found in memory, try to load it from disk.
540 // Returns true if sector now resides in memory
541 //bool deFlushSector(v2s16 p2d);
543 void saveBlock(MapBlock *block);
544 // This will generate a sector with getSector if not found.
545 void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector);
547 // For debug printing
548 virtual void PrintInfo(std::ostream &out);
550 bool isSavingEnabled(){ return m_map_saving_enabled; }
553 // Seed used for all kinds of randomness
556 std::string m_savedir;
557 bool m_map_saving_enabled;
559 // Chunk size in MapSectors
562 core::map<v2s16, MapChunk*> m_chunks;
571 struct MapDrawControl
576 wanted_max_blocks(0),
579 blocks_would_have_drawn(0)
582 // Overrides limits by drawing everything
584 // Wanted drawing range
586 // Maximum number of blocks to draw
587 u32 wanted_max_blocks;
588 // Blocks in this range are drawn regardless of number of blocks drawn
589 float wanted_min_range;
590 // Number of blocks rendered is written here by the renderer
592 // Number of blocks that would have been drawn in wanted_range
593 u32 blocks_would_have_drawn;
601 This is the only map class that is able to render itself on screen.
604 class ClientMap : public Map, public scene::ISceneNode
609 MapDrawControl &control,
610 scene::ISceneNode* parent,
611 scene::ISceneManager* mgr,
619 return MAPTYPE_CLIENT;
627 void updateCamera(v3f pos, v3f dir)
629 JMutexAutoLock lock(m_camera_mutex);
630 m_camera_position = pos;
631 m_camera_direction = dir;
635 Forcefully get a sector from somewhere
637 MapSector * emergeSector(v2s16 p);
639 void deSerializeSector(v2s16 p2d, std::istream &is);
645 virtual void OnRegisterSceneNode();
647 virtual void render()
649 video::IVideoDriver* driver = SceneManager->getVideoDriver();
650 driver->setTransform(video::ETS_WORLD, AbsoluteTransformation);
651 renderMap(driver, SceneManager->getSceneNodeRenderPass());
654 virtual const core::aabbox3d<f32>& getBoundingBox() const
659 void renderMap(video::IVideoDriver* driver, s32 pass);
662 Methods for setting temporary modifications to nodes for
665 Returns true if something changed.
667 All blocks whose mesh could have been changed are inserted
670 bool setTempMod(v3s16 p, NodeMod mod,
671 core::map<v3s16, MapBlock*> *affected_blocks=NULL);
672 bool clearTempMod(v3s16 p,
673 core::map<v3s16, MapBlock*> *affected_blocks=NULL);
674 // Efficient implementation needs a cache of TempMods
675 //void clearTempMods();
677 void expireMeshes(bool only_daynight_diffed);
680 Update the faces of the given block and blocks on the
683 void updateMeshes(v3s16 blockpos, u32 daynight_ratio);
685 // Update meshes that touch the node
686 //void updateNodeMeshes(v3s16 nodepos, u32 daynight_ratio);
688 // For debug printing
689 virtual void PrintInfo(std::ostream &out);
694 core::aabbox3d<f32> m_box;
696 // This is the master heightmap mesh
697 //scene::SMesh *mesh;
700 MapDrawControl &m_control;
702 v3f m_camera_position;
703 v3f m_camera_direction;
704 JMutex m_camera_mutex;
710 class MapVoxelManipulator : public VoxelManipulator
713 MapVoxelManipulator(Map *map);
714 virtual ~MapVoxelManipulator();
718 VoxelManipulator::clear();
719 m_loaded_blocks.clear();
722 virtual void emerge(VoxelArea a, s32 caller_id=-1);
724 void blitBack(core::map<v3s16, MapBlock*> & modified_blocks);
730 value = block existed when loaded
732 core::map<v3s16, bool> m_loaded_blocks;
735 class ManualMapVoxelManipulator : public MapVoxelManipulator
738 ManualMapVoxelManipulator(Map *map);
739 virtual ~ManualMapVoxelManipulator();
741 void setMap(Map *map)
744 virtual void emerge(VoxelArea a, s32 caller_id=-1);
746 void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max);
748 // This is much faster with big chunks of generated data
749 void blitBackAll(core::map<v3s16, MapBlock*> * modified_blocks);
757 ManualMapVoxelManipulator vmanip;
762 v2s16 sectorpos_base;
763 s16 sectorpos_base_size;
764 v2s16 sectorpos_bigbase;
765 s16 sectorpos_bigbase_size;
766 s16 max_spread_amount;
773 void makeChunk(ChunkMakeData *data);