StructureSaverAbstract

interface StructureSaverAbstract<L, V>

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

Functions

abstract fun at(location: L): StructureSaverAbstract<L, V>

Sets the source Location corner where the blocks start to get saved.

author

abstract fun author(author: String): StructureSaverAbstract<L, V>

Sets the author.

getAuthor

abstract fun getAuthor(): String

Gets the author.

getLocation

abstract fun getLocation(): L

Gets the source Location.

getOffset

abstract fun getOffset(): V

Gets the offset of the selection.

getRestriction

abstract fun getRestriction(): StructureRestriction

Gets the size restriction.

getStructureVoidTypeName

@Deprecated

~~abstract~~ ~~fun~~ ~~getStructureVoidTypeName~~(): String

This internal value is no longer exposed since 1.18.2.

includeEntities

abstract fun includeEntities(enabled: Boolean): StructureSaverAbstract<L, V>

Should entities be included in the save file.

isIncludeEntitiesEnabled

abstract fun isIncludeEntitiesEnabled(): Boolean

Should entities included in the saved file.

offSet

abstract fun offSet(vector: V): StructureSaverAbstract<L, V>

Sets the source Vector offset where the blocks reach to get saved.

restriction

abstract fun restriction(structureRestriction: StructureRestriction): StructureSaverAbstract<L, V>

Restricts the structure to a certain size if a larger area is selected with offset.

saveToFile

abstract fun saveToFile(target: File): ProgressToken<Void>

Saves the blocks and entities from the world into into a structure.nbt file.

saveToOutputStream

abstract fun saveToOutputStream(target: OutputStream): ProgressToken<Void>

Saves the blocks and entities from the world into into a structure.nbt binary stream.

saveToPath

abstract fun saveToPath(target: Path): ProgressToken<Void>

Saves the blocks and entities from the world into into a structure.nbt file.

saveToString

abstract fun saveToString(): ProgressToken<String>

Saves the blocks and entities from the world into into a structure.nbt binary as Base64 encoded string.

saveToWorld

abstract fun saveToWorld(worldName: String, author: String, name: String): ProgressToken<Void>

Saves the blocks and entities from the world into into a structure.nbt file located in the world folder, author folder.

sizeX

abstract fun sizeX(x: Int): StructureSaverAbstract<L, V>

Sets the offset in x coordinate.

sizeY

abstract fun sizeY(y: Int): StructureSaverAbstract<L, V>

Sets the offset in y coordinate.

sizeZ

abstract fun sizeZ(z: Int): StructureSaverAbstract<L, V>

Sets the offset in z coordinate.

structureVoidTypeName

@Deprecated

~~abstract~~ ~~fun~~ ~~structureVoidTypeName~~(~~name~~: String): StructureSaverAbstract<L, V>

This value is no longer used since 1.18.2.

Inheritors

StructureSaver