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 class ServerMap : public Map
325 savedir: directory to which map data should be saved
327 ServerMap(std::string savedir);
332 return MAPTYPE_SERVER;
339 // Returns the position of the chunk where the sector is in
340 v2s16 sector_to_chunk(v2s16 sectorpos)
342 sectorpos.X += m_chunksize / 2;
343 sectorpos.Y += m_chunksize / 2;
344 v2s16 chunkpos = getContainerPos(sectorpos, m_chunksize);
348 // Returns the position of the (0,0) sector of the chunk
349 v2s16 chunk_to_sector(v2s16 chunkpos)
352 chunkpos.X * m_chunksize,
353 chunkpos.Y * m_chunksize
355 sectorpos.X -= m_chunksize / 2;
356 sectorpos.Y -= m_chunksize / 2;
363 MapChunk *getChunk(v2s16 chunkpos)
365 core::map<v2s16, MapChunk*>::Node *n;
366 n = m_chunks.find(chunkpos);
369 return n->getValue();
373 True if the chunk and its neighbors are fully generated.
374 It means the chunk will not be touched in the future by the
375 generator. If false, generateChunk will make it true.
377 bool chunkNonVolatile(v2s16 chunkpos)
379 /*for(s16 x=-1; x<=1; x++)
380 for(s16 y=-1; y<=1; y++)*/
384 v2s16 chunkpos0 = chunkpos + v2s16(x,y);
385 MapChunk *chunk = getChunk(chunkpos);
388 if(chunk->getGenLevel() != GENERATED_FULLY)
397 All chunks touching this one can be altered also.
399 MapChunk* generateChunkRaw(v2s16 chunkpos,
400 core::map<v3s16, MapBlock*> &changed_blocks,
404 Generate a chunk and its neighbors so that it won't be touched
407 MapChunk* generateChunk(v2s16 chunkpos,
408 core::map<v3s16, MapBlock*> &changed_blocks);
413 This is mainly called by generateChunkRaw.
415 //ServerMapSector * generateSector(v2s16 p);
418 Get a sector from somewhere.
420 - Check disk (loads blocks also)
423 ServerMapSector * createSector(v2s16 p);
426 Get a sector from somewhere.
428 - Check disk (loads blocks also)
431 MapSector * emergeSector(v2s16 p,
432 core::map<v3s16, MapBlock*> &changed_blocks);
434 MapSector * emergeSector(v2s16 p)
436 core::map<v3s16, MapBlock*> changed_blocks;
437 return emergeSector(p, changed_blocks);
440 MapBlock * generateBlock(
442 MapBlock *original_dummy,
443 ServerMapSector *sector,
444 core::map<v3s16, MapBlock*> &changed_blocks,
445 core::map<v3s16, MapBlock*> &lighting_invalidated_blocks
449 Get a block from somewhere.
453 MapBlock * createBlock(v3s16 p);
456 only_from_disk, changed_blocks and lighting_invalidated_blocks
457 are not properly used by the new map generator.
459 MapBlock * emergeBlock(
462 core::map<v3s16, MapBlock*> &changed_blocks,
463 core::map<v3s16, MapBlock*> &lighting_invalidated_blocks
468 Forcefully get a block from somewhere.
471 - InvalidPositionException: possible if only_from_disk==true
474 - All already existing blocks that were modified are added.
475 - If found on disk, nothing will be added.
476 - If generated, the new block will not be included.
478 lighting_invalidated_blocks:
479 - All blocks that have heavy-to-calculate lighting changes
481 - updateLighting() should be called for these.
483 - A block that is in changed_blocks may not be in
484 lighting_invalidated_blocks.
486 MapBlock * emergeBlock(
489 core::map<v3s16, MapBlock*> &changed_blocks,
490 core::map<v3s16, MapBlock*> &lighting_invalidated_blocks
494 // Helper for placing objects on ground level
495 s16 findGroundLevel(v2s16 p2d);
498 Misc. helper functions for fiddling with directory and file
501 void createDir(std::string path);
502 void createSaveDir();
503 // returns something like "xxxxxxxx"
504 std::string getSectorSubDir(v2s16 pos);
505 // returns something like "map/sectors/xxxxxxxx"
506 std::string getSectorDir(v2s16 pos);
507 std::string createSectorDir(v2s16 pos);
508 // dirname: final directory name
509 v2s16 getSectorPos(std::string dirname);
510 v3s16 getBlockPos(std::string sectordir, std::string blockfile);
512 void save(bool only_changed);
515 // Saves map seed and possibly other stuff
519 void saveChunkMeta();
520 void loadChunkMeta();
522 // The sector mutex should be locked when calling most of these
524 // This only saves sector-specific data such as the heightmap
526 // DEPRECATED? Sectors have no metadata anymore.
527 void saveSectorMeta(ServerMapSector *sector);
528 MapSector* loadSectorMeta(std::string dirname);
530 // Full load of a sector including all blocks.
531 // returns true on success, false on failure.
532 bool loadSectorFull(v2s16 p2d);
533 // If sector is not found in memory, try to load it from disk.
534 // Returns true if sector now resides in memory
535 //bool deFlushSector(v2s16 p2d);
537 void saveBlock(MapBlock *block);
538 // This will generate a sector with getSector if not found.
539 void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector);
541 // For debug printing
542 virtual void PrintInfo(std::ostream &out);
544 bool isSavingEnabled(){ return m_map_saving_enabled; }
547 // Seed used for all kinds of randomness
550 std::string m_savedir;
551 bool m_map_saving_enabled;
553 // Chunk size in MapSectors
556 core::map<v2s16, MapChunk*> m_chunks;
565 struct MapDrawControl
570 wanted_max_blocks(0),
573 blocks_would_have_drawn(0)
576 // Overrides limits by drawing everything
578 // Wanted drawing range
580 // Maximum number of blocks to draw
581 u32 wanted_max_blocks;
582 // Blocks in this range are drawn regardless of number of blocks drawn
583 float wanted_min_range;
584 // Number of blocks rendered is written here by the renderer
586 // Number of blocks that would have been drawn in wanted_range
587 u32 blocks_would_have_drawn;
595 This is the only map class that is able to render itself on screen.
598 class ClientMap : public Map, public scene::ISceneNode
603 MapDrawControl &control,
604 scene::ISceneNode* parent,
605 scene::ISceneManager* mgr,
613 return MAPTYPE_CLIENT;
621 void updateCamera(v3f pos, v3f dir)
623 JMutexAutoLock lock(m_camera_mutex);
624 m_camera_position = pos;
625 m_camera_direction = dir;
629 Forcefully get a sector from somewhere
631 MapSector * emergeSector(v2s16 p);
633 void deSerializeSector(v2s16 p2d, std::istream &is);
639 virtual void OnRegisterSceneNode();
641 virtual void render()
643 video::IVideoDriver* driver = SceneManager->getVideoDriver();
644 driver->setTransform(video::ETS_WORLD, AbsoluteTransformation);
645 renderMap(driver, SceneManager->getSceneNodeRenderPass());
648 virtual const core::aabbox3d<f32>& getBoundingBox() const
653 void renderMap(video::IVideoDriver* driver, s32 pass);
656 Methods for setting temporary modifications to nodes for
659 Returns true if something changed.
661 All blocks whose mesh could have been changed are inserted
664 bool setTempMod(v3s16 p, NodeMod mod,
665 core::map<v3s16, MapBlock*> *affected_blocks=NULL);
666 bool clearTempMod(v3s16 p,
667 core::map<v3s16, MapBlock*> *affected_blocks=NULL);
668 // Efficient implementation needs a cache of TempMods
669 //void clearTempMods();
671 void expireMeshes(bool only_daynight_diffed);
674 Update the faces of the given block and blocks on the
677 void updateMeshes(v3s16 blockpos, u32 daynight_ratio);
679 // Update meshes that touch the node
680 //void updateNodeMeshes(v3s16 nodepos, u32 daynight_ratio);
682 // For debug printing
683 virtual void PrintInfo(std::ostream &out);
688 core::aabbox3d<f32> m_box;
690 // This is the master heightmap mesh
691 //scene::SMesh *mesh;
694 MapDrawControl &m_control;
696 v3f m_camera_position;
697 v3f m_camera_direction;
698 JMutex m_camera_mutex;
704 class MapVoxelManipulator : public VoxelManipulator
707 MapVoxelManipulator(Map *map);
708 virtual ~MapVoxelManipulator();
712 VoxelManipulator::clear();
713 m_loaded_blocks.clear();
716 virtual void emerge(VoxelArea a, s32 caller_id=-1);
718 void blitBack(core::map<v3s16, MapBlock*> & modified_blocks);
724 value = block existed when loaded
726 core::map<v3s16, bool> m_loaded_blocks;
729 class ManualMapVoxelManipulator : public MapVoxelManipulator
732 ManualMapVoxelManipulator(Map *map);
733 virtual ~ManualMapVoxelManipulator();
735 void setMap(Map *map)
738 virtual void emerge(VoxelArea a, s32 caller_id=-1);
740 void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max);
742 // This is much faster with big chunks of generated data
743 void blitBackAll(core::map<v3s16, MapBlock*> * modified_blocks);