StructureSaverAbstract

interface StructureSaverAbstract<L, V>
Content copied to clipboard

Interface fluent API to save structures from the world into different targets.

Functions

at
Link copied to clipboard
abstract fun at(location: L): StructureSaverAbstract<L, V>
Content copied to clipboard
Sets the source Location corner where the blocks start to get saved.
author
Link copied to clipboard
abstract fun author(author: String): StructureSaverAbstract<L, V>
Content copied to clipboard
Sets the author.
getAuthor
Link copied to clipboard
abstract fun getAuthor(): String
Content copied to clipboard
Gets the author.
getLocation
Link copied to clipboard
abstract fun getLocation(): L
Content copied to clipboard
Gets the source Location.
getOffset
Link copied to clipboard
abstract fun getOffset(): V
Content copied to clipboard
Gets the offset of the selection.
getRestriction
Link copied to clipboard
abstract fun getRestriction(): StructureRestriction
Content copied to clipboard
Gets the size restriction.
getStructureVoidTypeName
Link copied to clipboard
@Deprecated
abstract fun getStructureVoidTypeName(): String
Content copied to clipboard
This internal value is no longer exposed since 1.18.2.
includeEntities
Link copied to clipboard
abstract fun includeEntities(enabled: Boolean): StructureSaverAbstract<L, V>
Content copied to clipboard
Should entities be included in the save file.
isIncludeEntitiesEnabled
Link copied to clipboard
abstract fun isIncludeEntitiesEnabled(): Boolean
Content copied to clipboard
Should entities included in the saved file.
offSet
Link copied to clipboard
abstract fun offSet(vector: V): StructureSaverAbstract<L, V>
Content copied to clipboard
Sets the source Vector offset where the blocks reach to get saved.
restriction
Link copied to clipboard
abstract fun restriction(structureRestriction: StructureRestriction): StructureSaverAbstract<L, V>
Content copied to clipboard
Restricts the structure to a certain size if a larger area is selected with offset.
saveToFile
Link copied to clipboard
abstract fun saveToFile(target: File): ProgressToken<Void>
Content copied to clipboard
Saves the blocks and entities from the world into into a structure.nbt file.
saveToOutputStream
Link copied to clipboard
abstract fun saveToOutputStream(target: OutputStream): ProgressToken<Void>
Content copied to clipboard
Saves the blocks and entities from the world into into a structure.nbt binary stream.
saveToPath
Link copied to clipboard
abstract fun saveToPath(target: Path): ProgressToken<Void>
Content copied to clipboard
Saves the blocks and entities from the world into into a structure.nbt file.
saveToString
Link copied to clipboard
abstract fun saveToString(): ProgressToken<String>
Content copied to clipboard
Saves the blocks and entities from the world into into a structure.nbt binary as Base64 encoded string.
saveToWorld
Link copied to clipboard
abstract fun saveToWorld(worldName: String, author: String, name: String): ProgressToken<Void>
Content copied to clipboard
Saves the blocks and entities from the world into into a structure.nbt file located in the world folder, author folder.
sizeX
Link copied to clipboard
abstract fun sizeX(x: Int): StructureSaverAbstract<L, V>
Content copied to clipboard
Sets the offset in x coordinate.
sizeY
Link copied to clipboard
abstract fun sizeY(y: Int): StructureSaverAbstract<L, V>
Content copied to clipboard
Sets the offset in y coordinate.
sizeZ
Link copied to clipboard
abstract fun sizeZ(z: Int): StructureSaverAbstract<L, V>
Content copied to clipboard
Sets the offset in z coordinate.
structureVoidTypeName
Link copied to clipboard
@Deprecated
abstract fun structureVoidTypeName(name: String): StructureSaverAbstract<L, V>
Content copied to clipboard
This value is no longer used since 1.18.2.

Inheritors

StructureSaver
Link copied to clipboard