minetest/src/map.h

568 lines
14 KiB
C
Raw Normal View History

2010-11-27 00:02:21 +01:00
/*
2013-02-24 18:40:43 +01:00
Minetest
2013-02-24 19:38:45 +01:00
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
2010-11-27 00:02:21 +01:00
*/
#ifndef MAP_HEADER
#define MAP_HEADER
#include <iostream>
#include <sstream>
2012-12-20 18:19:49 +01:00
#include <set>
#include <map>
#include <list>
2010-11-27 00:02:21 +01:00
2012-06-17 03:00:31 +02:00
#include "irrlichttypes_bloated.h"
2010-11-27 00:02:21 +01:00
#include "mapnode.h"
#include "constants.h"
#include "voxel.h"
#include "modifiedstate.h"
#include "util/container.h"
2012-07-17 15:00:04 +02:00
#include "nodetimer.h"
class Database;
2012-03-15 23:25:18 +01:00
class ClientMap;
2011-06-25 23:03:58 +02:00
class MapSector;
class ServerMapSector;
class MapBlock;
2011-06-26 01:34:36 +02:00
class NodeMetadata;
class IGameDef;
class IRollbackReportSink;
class EmergeManager;
class ServerEnvironment;
struct BlockMakeData;
struct MapgenParams;
2011-06-25 23:03:58 +02:00
2011-06-25 17:35:32 +02:00
2011-06-05 20:07:54 +02:00
/*
MapEditEvent
*/
2010-11-27 00:02:21 +01:00
#define MAPTYPE_BASE 0
#define MAPTYPE_SERVER 1
#define MAPTYPE_CLIENT 2
2011-02-23 01:49:57 +01:00
enum MapEditEventType{
// Node added (changed from air or something else to something)
2011-02-23 01:49:57 +01:00
MEET_ADDNODE,
// Node removed (changed to air)
2011-02-23 01:49:57 +01:00
MEET_REMOVENODE,
2013-11-23 15:35:49 +01:00
// Node swapped (changed without metadata change)
MEET_SWAPNODE,
// Node metadata of block changed (not knowing which node exactly)
// p stores block coordinate
MEET_BLOCK_NODE_METADATA_CHANGED,
// Anything else (modified_blocks are set unsent)
2011-02-23 01:49:57 +01:00
MEET_OTHER
};
struct MapEditEvent
{
MapEditEventType type;
v3s16 p;
MapNode n;
2012-12-20 18:19:49 +01:00
std::set<v3s16> modified_blocks;
2011-02-23 01:49:57 +01:00
u16 already_known_by_peer;
MapEditEvent():
type(MEET_OTHER),
already_known_by_peer(0)
{
}
2011-02-23 01:49:57 +01:00
MapEditEvent * clone()
{
MapEditEvent *event = new MapEditEvent();
event->type = type;
event->p = p;
event->n = n;
2012-12-20 18:19:49 +01:00
event->modified_blocks = modified_blocks;
2011-02-23 01:49:57 +01:00
return event;
}
VoxelArea getArea()
{
switch(type){
case MEET_ADDNODE:
return VoxelArea(p);
case MEET_REMOVENODE:
return VoxelArea(p);
2013-11-23 15:35:49 +01:00
case MEET_SWAPNODE:
return VoxelArea(p);
case MEET_BLOCK_NODE_METADATA_CHANGED:
{
v3s16 np1 = p*MAP_BLOCKSIZE;
v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
return VoxelArea(np1, np2);
}
case MEET_OTHER:
{
VoxelArea a;
2012-12-20 18:19:49 +01:00
for(std::set<v3s16>::iterator
i = modified_blocks.begin();
i != modified_blocks.end(); ++i)
{
2012-12-20 18:19:49 +01:00
v3s16 p = *i;
v3s16 np1 = p*MAP_BLOCKSIZE;
v3s16 np2 = np1 + v3s16(1,1,1)*MAP_BLOCKSIZE - v3s16(1,1,1);
a.addPoint(np1);
a.addPoint(np2);
}
return a;
}
}
return VoxelArea();
}
2011-02-23 01:49:57 +01:00
};
class MapEventReceiver
{
public:
// event shall be deleted by caller after the call.
virtual void onMapEditEvent(MapEditEvent *event) = 0;
};
2011-06-26 00:31:43 +02:00
class Map /*: public NodeContainer*/
2010-11-27 00:02:21 +01:00
{
public:
Map(std::ostream &dout, IGameDef *gamedef);
2010-11-27 00:02:21 +01:00
virtual ~Map();
2011-06-26 00:31:43 +02:00
/*virtual u16 nodeContainerId() const
2010-11-27 00:02:21 +01:00
{
return NODECONTAINER_ID_MAP;
2011-06-26 00:31:43 +02:00
}*/
2010-11-27 00:02:21 +01:00
virtual s32 mapType() const
{
return MAPTYPE_BASE;
}
/*
Drop (client) or delete (server) the map.
*/
2010-12-19 15:51:45 +01:00
virtual void drop()
{
delete this;
}
2011-02-23 01:49:57 +01:00
void addEventReceiver(MapEventReceiver *event_receiver);
void removeEventReceiver(MapEventReceiver *event_receiver);
// event shall be deleted by caller after the call.
void dispatchEvent(MapEditEvent *event);
// On failure returns NULL
MapSector * getSectorNoGenerateNoExNoLock(v2s16 p2d);
// Same as the above (there exists no lock anymore)
MapSector * getSectorNoGenerateNoEx(v2s16 p2d);
// On failure throws InvalidPositionException
2010-11-27 00:02:21 +01:00
MapSector * getSectorNoGenerate(v2s16 p2d);
// Gets an existing sector or creates an empty one
//MapSector * getSectorCreate(v2s16 p2d);
2010-11-27 00:02:21 +01:00
/*
This is overloaded by ClientMap and ServerMap to allow
their differing fetch methods.
*/
virtual MapSector * emergeSector(v2s16 p){ return NULL; }
virtual MapSector * emergeSector(v2s16 p,
2012-12-20 18:19:49 +01:00
std::map<v3s16, MapBlock*> &changed_blocks){ return NULL; }
2010-11-27 00:02:21 +01:00
// Returns InvalidPositionException if not found
MapBlock * getBlockNoCreate(v3s16 p);
2010-12-21 17:08:24 +01:00
// Returns NULL if not found
MapBlock * getBlockNoCreateNoEx(v3s16 p);
/* Server overrides */
virtual MapBlock * emergeBlock(v3s16 p, bool allow_generate=true)
{ return getBlockNoCreateNoEx(p); }
2010-11-27 00:02:21 +01:00
// Returns InvalidPositionException if not found
bool isNodeUnderground(v3s16 p);
2011-06-26 01:34:36 +02:00
bool isValidPosition(v3s16 p);
2010-12-25 15:04:51 +01:00
// throws InvalidPositionException if not found
2011-06-26 01:34:36 +02:00
MapNode getNode(v3s16 p);
2010-11-27 00:02:21 +01:00
2010-12-25 15:04:51 +01:00
// throws InvalidPositionException if not found
2011-06-26 01:34:36 +02:00
void setNode(v3s16 p, MapNode & n);
// Returns a CONTENT_IGNORE node if not found
2011-06-26 01:34:36 +02:00
MapNode getNodeNoEx(v3s16 p);
2010-11-27 00:02:21 +01:00
2010-12-18 16:46:00 +01:00
void unspreadLight(enum LightBank bank,
2012-12-20 18:19:49 +01:00
std::map<v3s16, u8> & from_nodes,
std::set<v3s16> & light_sources,
std::map<v3s16, MapBlock*> & modified_blocks);
2010-11-27 00:02:21 +01:00
2010-12-18 16:46:00 +01:00
void unLightNeighbors(enum LightBank bank,
v3s16 pos, u8 lightwas,
2012-12-20 18:19:49 +01:00
std::set<v3s16> & light_sources,
std::map<v3s16, MapBlock*> & modified_blocks);
2010-12-18 16:46:00 +01:00
void spreadLight(enum LightBank bank,
2012-12-20 18:19:49 +01:00
std::set<v3s16> & from_nodes,
std::map<v3s16, MapBlock*> & modified_blocks);
2010-12-18 16:46:00 +01:00
void lightNeighbors(enum LightBank bank,
v3s16 pos,
2012-12-20 18:19:49 +01:00
std::map<v3s16, MapBlock*> & modified_blocks);
2010-11-27 00:02:21 +01:00
2010-12-18 16:46:00 +01:00
v3s16 getBrightestNeighbour(enum LightBank bank, v3s16 p);
2010-11-27 00:02:21 +01:00
s16 propagateSunlight(v3s16 start,
2012-12-20 18:19:49 +01:00
std::map<v3s16, MapBlock*> & modified_blocks);
2010-12-18 16:46:00 +01:00
void updateLighting(enum LightBank bank,
2012-12-20 18:19:49 +01:00
std::map<v3s16, MapBlock*> & a_blocks,
std::map<v3s16, MapBlock*> & modified_blocks);
2012-12-20 18:19:49 +01:00
void updateLighting(std::map<v3s16, MapBlock*> & a_blocks,
std::map<v3s16, MapBlock*> & modified_blocks);
2010-11-27 00:02:21 +01:00
/*
These handle lighting but not faces.
*/
void addNodeAndUpdate(v3s16 p, MapNode n,
2013-11-23 15:35:49 +01:00
std::map<v3s16, MapBlock*> &modified_blocks,
bool remove_metadata = true);
2010-11-27 00:02:21 +01:00
void removeNodeAndUpdate(v3s16 p,
2012-12-20 18:19:49 +01:00
std::map<v3s16, MapBlock*> &modified_blocks);
2011-02-23 01:49:57 +01:00
/*
Wrappers for the latter ones.
These emit events.
Return true if succeeded, false if not.
*/
2013-11-23 15:35:49 +01:00
bool addNodeWithEvent(v3s16 p, MapNode n, bool remove_metadata = true);
2011-02-23 01:49:57 +01:00
bool removeNodeWithEvent(v3s16 p);
2010-12-19 15:51:45 +01:00
/*
2010-12-21 17:08:24 +01:00
Takes the blocks at the edges into account
2010-12-19 15:51:45 +01:00
*/
bool getDayNightDiff(v3s16 blockpos);
2010-11-27 00:02:21 +01:00
//core::aabbox3d<s16> getDisplayedBlockArea();
//bool updateChangedVisibleArea();
// Call these before and after saving of many blocks
virtual void beginSave() {return;};
virtual void endSave() {return;};
virtual void save(ModifiedState save_level){assert(0);};
// Server implements this.
// Client leaves it as no-op.
virtual bool saveBlock(MapBlock *block) { return false; };
2010-11-27 00:02:21 +01:00
/*
Updates usage timers and unloads unused blocks and sectors.
Saves modified blocks before unloading on MAPTYPE_SERVER.
2010-11-27 00:02:21 +01:00
*/
void timerUpdate(float dtime, float unload_timeout,
2012-12-20 18:19:49 +01:00
std::list<v3s16> *unloaded_blocks=NULL);
/*
Unloads all blocks with a zero refCount().
Saves modified blocks before unloading on MAPTYPE_SERVER.
*/
void unloadUnreferencedBlocks(std::list<v3s16> *unloaded_blocks=NULL);
// Deletes sectors and their blocks from memory
2010-11-27 00:02:21 +01:00
// Takes cache into account
// If deleted sector is in sector cache, clears cache
2012-12-20 18:19:49 +01:00
void deleteSectors(std::list<v2s16> &list);
#if 0
/*
Unload unused data
= flush changed to disk and delete from memory, if usage timer of
block is more than timeout
*/
void unloadUnusedData(float timeout,
2010-11-27 00:02:21 +01:00
core::list<v3s16> *deleted_blocks=NULL);
#endif
2010-11-27 00:02:21 +01:00
// For debug printing. Prints "Map: ", "ServerMap: " or "ClientMap: "
2010-11-27 00:02:21 +01:00
virtual void PrintInfo(std::ostream &out);
2012-12-20 18:19:49 +01:00
void transformLiquids(std::map<v3s16, MapBlock*> & modified_blocks);
/*
Node metadata
These are basically coordinate wrappers to MapBlock
*/
2011-04-04 02:45:08 +02:00
NodeMetadata* getNodeMetadata(v3s16 p);
/**
* Sets metadata for a node.
* This method sets the metadata for a given node.
* On success, it returns @c true and the object pointed to
* by @p meta is then managed by the system and should
* not be deleted by the caller.
*
* In case of failure, the method returns @c false and the
* caller is still responsible for deleting the object!
*
* @param p node coordinates
* @param meta pointer to @c NodeMetadata object
* @return @c true on success, false on failure
*/
bool setNodeMetadata(v3s16 p, NodeMetadata *meta);
2011-04-04 02:45:08 +02:00
void removeNodeMetadata(v3s16 p);
2012-03-19 01:08:04 +01:00
2012-07-17 15:00:04 +02:00
/*
Node Timers
These are basically coordinate wrappers to MapBlock
*/
2012-07-17 15:00:04 +02:00
NodeTimer getNodeTimer(v3s16 p);
void setNodeTimer(v3s16 p, NodeTimer t);
void removeNodeTimer(v3s16 p);
/*
Misc.
*/
2012-12-20 18:19:49 +01:00
std::map<v2s16, MapSector*> *getSectorsPtr(){return &m_sectors;}
/*
Variables
*/
2013-02-24 15:39:07 +01:00
void transforming_liquid_add(v3s16 p);
s32 transforming_liquid_size();
protected:
2013-06-25 17:02:02 +02:00
friend class LuaVoxelManip;
std::ostream &m_dout; // A bit deprecated, could be removed
IGameDef *m_gamedef;
2012-12-20 18:19:49 +01:00
std::set<MapEventReceiver*> m_event_receivers;
2012-12-20 18:19:49 +01:00
std::map<v2s16, MapSector*> m_sectors;
// Be sure to set this to NULL when the cached sector is deleted
MapSector *m_sector_cache;
v2s16 m_sector_cache_p;
// Queued transforming water nodes
UniqueQueue<v3s16> m_transforming_liquid;
2010-11-27 00:02:21 +01:00
};
/*
ServerMap
This is the only map class that is able to generate map.
*/
2010-11-27 00:02:21 +01:00
class ServerMap : public Map
{
public:
/*
savedir: directory to which map data should be saved
*/
ServerMap(std::string savedir, IGameDef *gamedef, EmergeManager *emerge);
2010-11-27 00:02:21 +01:00
~ServerMap();
s32 mapType() const
{
return MAPTYPE_SERVER;
}
/*
Get a sector from somewhere.
- Check memory
- Check disk (doesn't load blocks)
- Create blank one
*/
ServerMapSector * createSector(v2s16 p);
/*
Blocks are generated by using these and makeBlock().
2010-11-27 00:02:21 +01:00
*/
2013-02-17 08:46:08 +01:00
bool initBlockMake(BlockMakeData *data, v3s16 blockpos);
void finishBlockMake(BlockMakeData *data,
2012-12-20 18:19:49 +01:00
std::map<v3s16, MapBlock*> &changed_blocks);
/*
Get a block from somewhere.
- Memory
- Create blank
*/
MapBlock * createBlock(v3s16 p);
2010-11-27 00:02:21 +01:00
/*
Forcefully get a block from somewhere.
- Memory
- Load from disk
- Create blank filled with CONTENT_IGNORE
2010-11-27 00:02:21 +01:00
*/
MapBlock * emergeBlock(v3s16 p, bool create_blank=true);
/*
Try to get a block.
If it does not exist in memory, add it to the emerge queue.
- Memory
- Emerge Queue (deferred disk or generate)
*/
MapBlock *getBlockOrEmerge(v3s16 p3d);
// Carries out any initialization necessary before block is sent
void prepareBlock(MapBlock *block);
2011-02-23 01:49:57 +01:00
// Helper for placing objects on ground level
s16 findGroundLevel(v2s16 p2d);
2010-11-27 00:02:21 +01:00
/*
Misc. helper functions for fiddling with directory and file
names when saving
*/
void createDirs(std::string path);
2010-11-27 00:02:21 +01:00
// returns something like "map/sectors/xxxxxxxx"
std::string getSectorDir(v2s16 pos, int layout = 2);
2010-11-27 00:02:21 +01:00
// dirname: final directory name
v2s16 getSectorPos(std::string dirname);
v3s16 getBlockPos(std::string sectordir, std::string blockfile);
static std::string getBlockFilename(v3s16 p);
2010-11-27 00:02:21 +01:00
/*
Database functions
*/
// Verify we can read/write to the database
void verifyDatabase();
// Returns true if the database file does not exist
bool loadFromFolders();
// Call these before and after saving of blocks
void beginSave();
void endSave();
void save(ModifiedState save_level);
2012-12-20 18:19:49 +01:00
void listAllLoadableBlocks(std::list<v3s16> &dst);
void listAllLoadedBlocks(std::list<v3s16> &dst);
2011-02-11 18:55:42 +01:00
// Saves map seed and possibly other stuff
2011-02-05 13:55:16 +01:00
void saveMapMeta();
void loadMapMeta();
/*void saveChunkMeta();
void loadChunkMeta();*/
2010-11-27 00:02:21 +01:00
// The sector mutex should be locked when calling most of these
2010-11-27 00:02:21 +01:00
// This only saves sector-specific data such as the heightmap
// (no MapBlocks)
2011-02-05 13:55:16 +01:00
// DEPRECATED? Sectors have no metadata anymore.
2010-11-27 00:02:21 +01:00
void saveSectorMeta(ServerMapSector *sector);
MapSector* loadSectorMeta(std::string dirname, bool save_after_load);
bool loadSectorMeta(v2s16 p2d);
2010-11-27 00:02:21 +01:00
// Full load of a sector including all blocks.
// returns true on success, false on failure.
bool loadSectorFull(v2s16 p2d);
// If sector is not found in memory, try to load it from disk.
// Returns true if sector now resides in memory
//bool deFlushSector(v2s16 p2d);
bool saveBlock(MapBlock *block, Database *db);
bool saveBlock(MapBlock *block);
2010-11-27 00:02:21 +01:00
// This will generate a sector with getSector if not found.
void loadBlock(std::string sectordir, std::string blockfile, MapSector *sector, bool save_after_load=false);
MapBlock* loadBlock(v3s16 p);
// Database version
void loadBlock(std::string *blob, v3s16 p3d, MapSector *sector, bool save_after_load=false);
2010-11-27 00:02:21 +01:00
void updateVManip(v3s16 pos);
2010-11-27 00:02:21 +01:00
// For debug printing
virtual void PrintInfo(std::ostream &out);
bool isSavingEnabled(){ return m_map_saving_enabled; }
u64 getSeed();
s16 getWaterLevel();
2013-07-27 20:34:30 +02:00
2010-11-27 00:02:21 +01:00
private:
// Emerge manager
EmergeManager *m_emerge;
2010-11-27 00:02:21 +01:00
std::string m_savedir;
bool m_map_saving_enabled;
#if 0
// Chunk size in MapSectors
2011-04-10 21:50:31 +02:00
// If 0, chunks are disabled.
s16 m_chunksize;
// Chunks
core::map<v2s16, MapChunk*> m_chunks;
#endif
/*
Metadata is re-written on disk only if this is true.
This is reset to false when written on disk.
*/
bool m_map_metadata_changed;
Database *dbase;
2010-11-27 00:02:21 +01:00
};
2013-02-17 07:47:49 +01:00
#define VMANIP_BLOCK_DATA_INEXIST 1
#define VMANIP_BLOCK_CONTAINS_CIGNORE 2
class ManualMapVoxelManipulator : public VoxelManipulator
{
public:
ManualMapVoxelManipulator(Map *map);
virtual ~ManualMapVoxelManipulator();
virtual void clear()
{
VoxelManipulator::clear();
m_loaded_blocks.clear();
}
void setMap(Map *map)
{m_map = map;}
void initialEmerge(v3s16 blockpos_min, v3s16 blockpos_max,
bool load_if_inexistent = true);
// This is much faster with big chunks of generated data
void blitBackAll(std::map<v3s16, MapBlock*> * modified_blocks,
bool overwrite_generated = true);
2011-01-24 15:36:58 +01:00
bool m_is_dirty;
2011-01-24 15:36:58 +01:00
protected:
bool m_create_area;
Map *m_map;
/*
key = blockpos
value = flags describing the block
*/
std::map<v3s16, u8> m_loaded_blocks;
2011-01-24 15:36:58 +01:00
};
2010-11-27 00:02:21 +01:00
#endif