diff options
Diffstat (limited to 'src/WorldStorage/WSSAnvil.h')
| -rwxr-xr-x | src/WorldStorage/WSSAnvil.h | 62 |
1 files changed, 34 insertions, 28 deletions
diff --git a/src/WorldStorage/WSSAnvil.h b/src/WorldStorage/WSSAnvil.h index 892645785..6c15877ff 100755 --- a/src/WorldStorage/WSSAnvil.h +++ b/src/WorldStorage/WSSAnvil.h @@ -29,13 +29,13 @@ class cWolf; enum { - /// Maximum number of chunks in an MCA file - also the count of the header items + /** Maximum number of chunks in an MCA file - also the count of the header items */ MCA_MAX_CHUNKS = 32 * 32, - /// The MCA header is 8 KiB + /** The MCA header is 8 KiB */ MCA_HEADER_SIZE = MCA_MAX_CHUNKS * 8, - /// There are 5 bytes of header in front of each chunk + /** There are 5 bytes of header in front of each chunk */ MCA_CHUNK_HEADER_LENGTH = 5, } ; @@ -59,7 +59,7 @@ protected: { public: - cMCAFile(const AString & a_FileName, int a_RegionX, int a_RegionZ); + cMCAFile(cWSSAnvil & a_ParentSchema, const AString & a_FileName, int a_RegionX, int a_RegionZ); bool GetChunkData (const cChunkCoords & a_Chunk, AString & a_Data); bool SetChunkData (const cChunkCoords & a_Chunk, const AString & a_Data); @@ -70,6 +70,8 @@ protected: const AString & GetFileName(void) const {return m_FileName; } protected: + + cWSSAnvil & m_ParentSchema; int m_RegionX; int m_RegionZ; @@ -83,10 +85,10 @@ protected: // Chunk timestamps, following the chunk headers unsigned m_TimeStamps[MCA_MAX_CHUNKS]; - /// Finds a free location large enough to hold a_Data. Gets a hint of the chunk coords, places the data there if it fits. Returns the sector number. + /** Finds a free location large enough to hold a_Data. Gets a hint of the chunk coords, places the data there if it fits. Returns the sector number. */ unsigned FindFreeLocation(int a_LocalX, int a_LocalZ, const AString & a_Data); - /// Opens a MCA file either for a Read operation (fails if doesn't exist) or for a Write operation (creates new if not found) + /** Opens a MCA file either for a Read operation (fails if doesn't exist) or for a Write operation (creates new if not found) */ bool OpenFile(bool a_IsForReading); } ; typedef std::list<cMCAFile *> cMCAFiles; @@ -96,47 +98,51 @@ protected: int m_CompressionFactor; - /// Gets chunk data from the correct file; locks file CS as needed + + /** Reports that the specified chunk failed to load and saves the chunk data to an external file. */ + void ChunkLoadFailed(int a_ChunkX, int a_ChunkZ, const AString & a_Reason, const AString & a_ChunkDataToSave); + + /** Gets chunk data from the correct file; locks file CS as needed */ bool GetChunkData(const cChunkCoords & a_Chunk, AString & a_Data); - /// Sets chunk data into the correct file; locks file CS as needed + /** Sets chunk data into the correct file; locks file CS as needed */ bool SetChunkData(const cChunkCoords & a_Chunk, const AString & a_Data); - /// Loads the chunk from the data (no locking needed) + /** Loads the chunk from the data (no locking needed) */ bool LoadChunkFromData(const cChunkCoords & a_Chunk, const AString & a_Data); - /// Saves the chunk into datastream (no locking needed) + /** Saves the chunk into datastream (no locking needed) */ bool SaveChunkToData(const cChunkCoords & a_Chunk, AString & a_Data); - /// Loads the chunk from NBT data (no locking needed) - bool LoadChunkFromNBT(const cChunkCoords & a_Chunk, const cParsedNBT & a_NBT); + /** Loads the chunk from NBT data (no locking needed). + a_RawChunkData is the raw (compressed) chunk data, used for offloading when chunk loading fails. */ + bool LoadChunkFromNBT(const cChunkCoords & a_Chunk, const cParsedNBT & a_NBT, const AString & a_RawChunkData); - /// Saves the chunk into NBT data using a_Writer; returns true on success + /** Saves the chunk into NBT data using a_Writer; returns true on success */ bool SaveChunkToNBT(const cChunkCoords & a_Chunk, cFastNBTWriter & a_Writer); - /// Loads the chunk's biome map from vanilla-format; returns a_BiomeMap if biomes present and valid, nullptr otherwise + /** Loads the chunk's biome map from vanilla-format; returns a_BiomeMap if biomes present and valid, nullptr otherwise */ cChunkDef::BiomeMap * LoadVanillaBiomeMapFromNBT(cChunkDef::BiomeMap * a_BiomeMap, const cParsedNBT & a_NBT, int a_TagIdx); - /// Loads the chunk's biome map from MCS format; returns a_BiomeMap if biomes present and valid, nullptr otherwise + /** Loads the chunk's biome map from MCS format; returns a_BiomeMap if biomes present and valid, nullptr otherwise */ cChunkDef::BiomeMap * LoadBiomeMapFromNBT(cChunkDef::BiomeMap * a_BiomeMap, const cParsedNBT & a_NBT, int a_TagIdx); - /// Loads the chunk's entities from NBT data (a_Tag is the Level\\Entities list tag; may be -1) + /** Loads the chunk's entities from NBT data (a_Tag is the Level\\Entities list tag; may be -1) */ void LoadEntitiesFromNBT(cEntityList & a_Entitites, const cParsedNBT & a_NBT, int a_Tag); - /// Loads the chunk's BlockEntities from NBT data (a_Tag is the Level\\TileEntities list tag; may be -1) + /** Loads the chunk's BlockEntities from NBT data (a_Tag is the Level\\TileEntities list tag; may be -1) */ void LoadBlockEntitiesFromNBT(cBlockEntityList & a_BlockEntitites, const cParsedNBT & a_NBT, int a_Tag, BLOCKTYPE * a_BlockTypes, NIBBLETYPE * a_BlockMetas); /** Loads the data for a block entity from the specified NBT tag. Returns the loaded block entity, or nullptr upon failure. */ cBlockEntity * LoadBlockEntityFromNBT(const cParsedNBT & a_NBT, int a_Tag, int a_BlockX, int a_BlockY, int a_BlockZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta); - /// Loads a cItem contents from the specified NBT tag; returns true if successful. Doesn't load the Slot tag + /** Loads a cItem contents from the specified NBT tag; returns true if successful. Doesn't load the Slot tag */ bool LoadItemFromNBT(cItem & a_Item, const cParsedNBT & a_NBT, int a_TagIdx); /** Loads contentents of an Items[] list tag into a cItemGrid ItemGrid begins at the specified slot offset - Slots outside the ItemGrid range are ignored - */ + Slots outside the ItemGrid range are ignored */ void LoadItemGridFromNBT(cItemGrid & a_ItemGrid, const cParsedNBT & a_NBT, int a_ItemsTagIdx, int s_SlotOffset = 0); /** Returns true iff the "id" child tag inside the specified tag equals the specified expected type. */ @@ -217,28 +223,28 @@ protected: /** Loads the wolf's owner information from the NBT into the specified wolf entity. */ void LoadWolfOwner(cWolf & a_Wolf, const cParsedNBT & a_NBT, int a_TagIdx); - /// Loads entity common data from the NBT compound; returns true if successful + /** Loads entity common data from the NBT compound; returns true if successful */ bool LoadEntityBaseFromNBT(cEntity & a_Entity, const cParsedNBT & a_NBT, int a_TagIdx); - /// Loads monster common data from the NBT compound; returns true if successful + /** Loads monster common data from the NBT compound; returns true if successful */ bool LoadMonsterBaseFromNBT(cMonster & a_Monster, const cParsedNBT & a_NBT, int a_TagIdx); - /// Loads projectile common data from the NBT compound; returns true if successful + /** Loads projectile common data from the NBT compound; returns true if successful */ bool LoadProjectileBaseFromNBT(cProjectileEntity & a_Entity, const cParsedNBT & a_NBT, int a_TagIx); - /// Loads an array of doubles of the specified length from the specified NBT list tag a_TagIdx; returns true if successful + /** Loads an array of doubles of the specified length from the specified NBT list tag a_TagIdx; returns true if successful */ bool LoadDoublesListFromNBT(double * a_Doubles, int a_NumDoubles, const cParsedNBT & a_NBT, int a_TagIdx); - /// Loads an array of floats of the specified length from the specified NBT list tag a_TagIdx; returns true if successful + /** Loads an array of floats of the specified length from the specified NBT list tag a_TagIdx; returns true if successful */ bool LoadFloatsListFromNBT(float * a_Floats, int a_NumFloats, const cParsedNBT & a_NBT, int a_TagIdx); - /// Helper function for extracting the X, Y, and Z int subtags of a NBT compound; returns true if successful + /** Helper function for extracting the X, Y, and Z int subtags of a NBT compound; returns true if successful */ bool GetBlockEntityNBTPos(const cParsedNBT & a_NBT, int a_TagIdx, int & a_X, int & a_Y, int & a_Z); - /// Gets the correct MCA file either from cache or from disk, manages the m_MCAFiles cache; assumes m_CS is locked + /** Gets the correct MCA file either from cache or from disk, manages the m_MCAFiles cache; assumes m_CS is locked */ cMCAFile * LoadMCAFile(const cChunkCoords & a_Chunk); - /// Copies a_Length bytes of data from the specified NBT Tag's Child into the a_Destination buffer + /** Copies a_Length bytes of data from the specified NBT Tag's Child into the a_Destination buffer */ void CopyNBTData(const cParsedNBT & a_NBT, int a_Tag, const AString & a_ChildName, char * a_Destination, size_t a_Length); // cWSSchema overrides: |