3 Copyright (C) 2010-2013 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.
28 #include "irrlichttypes_bloated.h"
30 #include "constants.h"
32 #include "modifiedstate.h"
33 #include "util/container.h"
34 #include "util/metricsbackend.h"
35 #include "nodetimer.h"
36 #include "map_settings_manager.h"
43 class ServerMapSector;
47 class IRollbackManager;
50 class ServerEnvironment;
57 enum MapEditEventType{
58 // Node added (changed from air or something else to something)
60 // Node removed (changed to air)
62 // Node swapped (changed without metadata change)
64 // Node metadata changed
65 MEET_BLOCK_NODE_METADATA_CHANGED,
66 // Anything else (modified_blocks are set unsent)
72 MapEditEventType type = MEET_OTHER;
74 MapNode n = CONTENT_AIR;
75 std::set<v3s16> modified_blocks;
76 bool is_private_change = false;
78 MapEditEvent() = default;
80 VoxelArea getArea() const
89 case MEET_BLOCK_NODE_METADATA_CHANGED:
91 v3s16 np1 = p*MAP_BLOCKSIZE;
92 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
93 return VoxelArea(np1, np2);
98 for (v3s16 p : modified_blocks) {
99 v3s16 np1 = p*MAP_BLOCKSIZE;
100 v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
111 class MapEventReceiver
114 // event shall be deleted by caller after the call.
115 virtual void onMapEditEvent(const MapEditEvent &event) = 0;
118 class Map /*: public NodeContainer*/
122 Map(IGameDef *gamedef);
124 DISABLE_CLASS_COPY(Map);
127 Drop (client) or delete (server) the map.
134 void addEventReceiver(MapEventReceiver *event_receiver);
135 void removeEventReceiver(MapEventReceiver *event_receiver);
136 // event shall be deleted by caller after the call.
137 void dispatchEvent(const MapEditEvent &event);
139 // On failure returns NULL
140 MapSector * getSectorNoGenerateNoLock(v2s16 p2d);
141 // Same as the above (there exists no lock anymore)
142 MapSector * getSectorNoGenerate(v2s16 p2d);
145 This is overloaded by ClientMap and ServerMap to allow
146 their differing fetch methods.
148 virtual MapSector * emergeSector(v2s16 p){ return NULL; }
150 // Returns InvalidPositionException if not found
151 MapBlock * getBlockNoCreate(v3s16 p);
152 // Returns NULL if not found
153 MapBlock * getBlockNoCreateNoEx(v3s16 p);
155 /* Server overrides */
156 virtual MapBlock * emergeBlock(v3s16 p, bool create_blank=true)
157 { return getBlockNoCreateNoEx(p); }
159 inline const NodeDefManager * getNodeDefManager() { return m_nodedef; }
161 bool isValidPosition(v3s16 p);
163 // throws InvalidPositionException if not found
164 void setNode(v3s16 p, MapNode & n);
166 // Returns a CONTENT_IGNORE node if not found
167 // If is_valid_position is not NULL then this will be set to true if the
168 // position is valid, otherwise false
169 MapNode getNode(v3s16 p, bool *is_valid_position = NULL);
172 These handle lighting but not faces.
174 virtual void addNodeAndUpdate(v3s16 p, MapNode n,
175 std::map<v3s16, MapBlock*> &modified_blocks,
176 bool remove_metadata = true);
177 void removeNodeAndUpdate(v3s16 p,
178 std::map<v3s16, MapBlock*> &modified_blocks);
181 Wrappers for the latter ones.
183 Return true if succeeded, false if not.
185 bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
186 bool removeNodeWithEvent(v3s16 p);
188 // Call these before and after saving of many blocks
189 virtual void beginSave() {}
190 virtual void endSave() {}
192 virtual void save(ModifiedState save_level) { FATAL_ERROR("FIXME"); }
195 Return true unless the map definitely cannot save blocks.
197 virtual bool maySaveBlocks() { return true; }
199 // Server implements these.
200 // Client leaves them as no-op.
201 virtual bool saveBlock(MapBlock *block) { return false; }
202 virtual bool deleteBlock(v3s16 blockpos) { return false; }
205 Updates usage timers and unloads unused blocks and sectors.
206 Saves modified blocks before unloading if possible.
208 void timerUpdate(float dtime, float unload_timeout, u32 max_loaded_blocks,
209 std::vector<v3s16> *unloaded_blocks=NULL);
212 Unloads all blocks with a zero refCount().
213 Saves modified blocks before unloading if possible.
215 void unloadUnreferencedBlocks(std::vector<v3s16> *unloaded_blocks=NULL);
217 // Deletes sectors and their blocks from memory
218 // Takes cache into account
219 // If deleted sector is in sector cache, clears cache
220 void deleteSectors(std::vector<v2s16> &list);
222 // For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
223 virtual void PrintInfo(std::ostream &out);
227 These are basically coordinate wrappers to MapBlock
230 std::vector<v3s16> findNodesWithMetadata(v3s16 p1, v3s16 p2);
231 NodeMetadata *getNodeMetadata(v3s16 p);
234 * Sets metadata for a node.
235 * This method sets the metadata for a given node.
236 * On success, it returns @c true and the object pointed to
237 * by @p meta is then managed by the system and should
238 * not be deleted by the caller.
240 * In case of failure, the method returns @c false and the
241 * caller is still responsible for deleting the object!
243 * @param p node coordinates
244 * @param meta pointer to @c NodeMetadata object
245 * @return @c true on success, false on failure
247 bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
248 void removeNodeMetadata(v3s16 p);
252 These are basically coordinate wrappers to MapBlock
255 NodeTimer getNodeTimer(v3s16 p);
256 void setNodeTimer(const NodeTimer &t);
257 void removeNodeTimer(v3s16 p);
263 bool isBlockOccluded(MapBlock *block, v3s16 cam_pos_nodes);
267 std::set<MapEventReceiver*> m_event_receivers;
269 std::map<v2s16, MapSector*> m_sectors;
271 // Be sure to set this to NULL when the cached sector is deleted
272 MapSector *m_sector_cache = nullptr;
273 v2s16 m_sector_cache_p;
275 // This stores the properties of the nodes on the map.
276 const NodeDefManager *m_nodedef;
278 bool determineAdditionalOcclusionCheck(const v3s16 &pos_camera,
279 const core::aabbox3d<s16> &block_bounds, v3s16 &check);
280 bool isOccluded(const v3s16 &pos_camera, const v3s16 &pos_target,
281 float step, float stepfac, float start_offset, float end_offset,
288 This is the only map class that is able to generate map.
291 class ServerMap : public Map
295 savedir: directory to which map data should be saved
297 ServerMap(const std::string &savedir, IGameDef *gamedef, EmergeManager *emerge, MetricsBackend *mb);
301 Get a sector from somewhere.
303 - Check disk (doesn't load blocks)
306 MapSector *createSector(v2s16 p);
309 Blocks are generated by using these and makeBlock().
311 bool blockpos_over_mapgen_limit(v3s16 p);
312 bool initBlockMake(v3s16 blockpos, BlockMakeData *data);
313 void finishBlockMake(BlockMakeData *data,
314 std::map<v3s16, MapBlock*> *changed_blocks);
317 Get a block from somewhere.
321 MapBlock *createBlock(v3s16 p);
324 Forcefully get a block from somewhere.
327 - Create blank filled with CONTENT_IGNORE
330 MapBlock *emergeBlock(v3s16 p, bool create_blank=true) override;
334 If it does not exist in memory, add it to the emerge queue.
336 - Emerge Queue (deferred disk or generate)
338 MapBlock *getBlockOrEmerge(v3s16 p3d);
340 bool isBlockInQueue(v3s16 pos);
342 void addNodeAndUpdate(v3s16 p, MapNode n,
343 std::map<v3s16, MapBlock*> &modified_blocks,
344 bool remove_metadata) override;
349 static MapDatabase *createDatabase(const std::string &name, const std::string &savedir, Settings &conf);
351 // Call these before and after saving of blocks
352 void beginSave() override;
353 void endSave() override;
355 void save(ModifiedState save_level) override;
356 void listAllLoadableBlocks(std::vector<v3s16> &dst);
357 void listAllLoadedBlocks(std::vector<v3s16> &dst);
359 MapgenParams *getMapgenParams();
361 bool saveBlock(MapBlock *block) override;
362 static bool saveBlock(MapBlock *block, MapDatabase *db, int compression_level = -1);
363 MapBlock* loadBlock(v3s16 p);
365 void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
367 bool deleteBlock(v3s16 blockpos) override;
369 void updateVManip(v3s16 pos);
371 // For debug printing
372 void PrintInfo(std::ostream &out) override;
374 bool isSavingEnabled(){ return m_map_saving_enabled; }
379 * Fixes lighting in one map block.
380 * May modify other blocks as well, as light can spread
381 * out of the specified block.
382 * Returns false if the block is not generated (so nothing
383 * changed), true otherwise.
385 bool repairBlockLight(v3s16 blockpos,
386 std::map<v3s16, MapBlock *> *modified_blocks);
388 void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks,
389 ServerEnvironment *env);
391 void transforming_liquid_add(v3s16 p);
393 MapSettingsManager settings_mgr;
396 friend class LuaVoxelManip;
399 EmergeManager *m_emerge;
401 std::string m_savedir;
402 bool m_map_saving_enabled;
404 int m_map_compression_level;
406 std::set<v3s16> m_chunks_in_progress;
408 // Queued transforming water nodes
409 UniqueQueue<v3s16> m_transforming_liquid;
410 f32 m_transforming_liquid_loop_count_multiplier = 1.0f;
411 u32 m_unprocessed_count = 0;
412 u64 m_inc_trending_up_start_time = 0; // milliseconds
413 bool m_queue_size_timer_started = false;
416 Metadata is re-written on disk only if this is true.
417 This is reset to false when written on disk.
419 bool m_map_metadata_changed = true;
420 MapDatabase *dbase = nullptr;
421 MapDatabase *dbase_ro = nullptr;
423 MetricCounterPtr m_save_time_counter;
427 #define VMANIP_BLOCK_DATA_INEXIST 1
428 #define VMANIP_BLOCK_CONTAINS_CIGNORE 2
430 class MMVManip : public VoxelManipulator
434 virtual ~MMVManip() = default;
438 VoxelManipulator::clear();
439 m_loaded_blocks.clear();
442 void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
443 bool load_if_inexistent = true);
445 // This is much faster with big chunks of generated data
446 void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
447 bool overwrite_generated = true);
450 Creates a copy of this VManip including contents, the copy will not be
451 associated with a Map.
453 MMVManip *clone() const;
455 // Reassociates a copied VManip to a map
456 void reparent(Map *map);
458 // Is it impossible to call initialEmerge / blitBackAll?
459 inline bool isOrphan() const { return !m_map; }
461 bool m_is_dirty = false;
467 Map *m_map = nullptr;
470 value = flags describing the block
472 std::map<v3s16, u8> m_loaded_blocks;