diff options
author | Howaner <franzi.moos@googlemail.com> | 2014-04-03 22:03:18 +0200 |
---|---|---|
committer | Howaner <franzi.moos@googlemail.com> | 2014-04-03 22:03:18 +0200 |
commit | 32d054e8fdad1d486fd4edbb542daa3262220e5f (patch) | |
tree | 1094c471768b71e8cac1277c2fbea5a5d9f2caf9 /src/WorldStorage/SchematicFileSerializer.h | |
parent | Remove old function (diff) | |
parent | APIDump: Added angular specifics. (diff) | |
download | cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.gz cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.bz2 cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.lz cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.xz cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.zst cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.zip |
Diffstat (limited to '')
-rw-r--r-- | src/WorldStorage/SchematicFileSerializer.h | 33 |
1 files changed, 29 insertions, 4 deletions
diff --git a/src/WorldStorage/SchematicFileSerializer.h b/src/WorldStorage/SchematicFileSerializer.h index 9be2e5b57..05b6c74f4 100644 --- a/src/WorldStorage/SchematicFileSerializer.h +++ b/src/WorldStorage/SchematicFileSerializer.h @@ -1,4 +1,12 @@ +// SchematicFileSerializer.h + +// Declares the cSchematicFileSerializer class representing the interface to load and save cBlockArea to a .schematic file + + + + + #pragma once #include "../BlockArea.h" @@ -13,17 +21,34 @@ class cParsedNBT; + class cSchematicFileSerializer { public: - /// Loads an area from a .schematic file. Returns true if successful + /** Loads an area from a .schematic file. Returns true if successful. */ static bool LoadFromSchematicFile(cBlockArea & a_BlockArea, const AString & a_FileName); - /// Saves the area into a .schematic file. Returns true if successful - static bool SaveToSchematicFile(cBlockArea & a_BlockArea, const AString & a_FileName); + /** Loads an area from a string containing the .schematic file data. Returns true if successful. */ + static bool LoadFromSchematicString(cBlockArea & a_BlockArea, const AString & a_SchematicData); + + /** Saves the area into a .schematic file. Returns true if successful. */ + static bool SaveToSchematicFile(const cBlockArea & a_BlockArea, const AString & a_FileName); + + /** Saves the area into a string containing the .schematic file data. + Returns true if successful, false on failure. The data is stored into a_Out. */ + static bool SaveToSchematicString(const cBlockArea & a_BlockArea, AString & a_Out); private: - /// Loads the area from a schematic file uncompressed and parsed into a NBT tree. Returns true if successful. + /** Loads the area from a schematic file uncompressed and parsed into a NBT tree. + Returns true if successful. */ static bool LoadFromSchematicNBT(cBlockArea & a_BlockArea, cParsedNBT & a_NBT); + + /** Saves the area into a NBT representation and returns the NBT data as a string. + Returns an empty string if failed. */ + static AString SaveToSchematicNBT(const cBlockArea & a_BlockArea); }; + + + + |