structureblocklib-root

com.github.shynixn.structureblocklib.api.bukkit.entity

StructureLoader

StructureLoader

interface StructureLoader : StructureLoaderAbstract<Location, Vector, Block, Entity, World>

Bukkit Wrapper for StructureLoader.

Functions

at

abstract fun at(location: L): StructureLoaderAbstract<L, V, B, E, W>

Sets the target Location corner where the blocks start to get placed.

getIntegrity

abstract fun getIntegrity(): Float

Gets the target integrity.

getLocation

abstract fun getLocation(): L

Gets the target Location.

getMirrorType

abstract fun getMirrorType(): StructureMirror

Gets the target mirror type.

getRotationType

abstract fun getRotationType(): StructureRotation

Gets the target rotation type.

getSeed

abstract fun getSeed(): Long

Gets the target seed.

includeBlocks

abstract fun includeBlocks(enabled: Boolean): StructureLoaderAbstract<L, V, B, E, W>

Should blocks which may or may not be included in the saved file be included in the loaded structure.

includeEntities

abstract fun includeEntities(enabled: Boolean): StructureLoaderAbstract<L, V, B, E, W>

Should entities which may or may not be included in the saved file be included in the loaded structure.

integrity

abstract fun integrity(integrity: Float): StructureLoaderAbstract<L, V, B, E, W>

Sets the target integrity.

isIncludeBlocksEnabled

abstract fun isIncludeBlocksEnabled(): Boolean

Should blocks which may or may not be included in the saved file be included in the loaded structure.

isIncludeEntitiesEnabled

abstract fun isIncludeEntitiesEnabled(): Boolean

Should entities which may or may not be included in the saved file be included in the loaded structure.

loadFromFile

abstract fun loadFromFile(source: File): ProgressToken<Void>

Loads the structure blocks and entities from the given source and places the blocks at the defined position.

loadFromInputStream

abstract fun loadFromInputStream(source: InputStream): ProgressToken<Void>

Loads the structure blocks and entities from the given source and places the blocks at the defined position.

loadFromPath

abstract fun loadFromPath(source: Path): ProgressToken<Void>

Loads the structure blocks and entities from the given source and places the blocks at the defined position.

loadFromSaver

abstract fun loadFromSaver(source: StructureSaverAbstract<L, V>): ProgressToken<Void>

Loads the structure blocks and entities from the given source and places the blocks at the defined position.

loadFromString

abstract fun loadFromString(source: String): ProgressToken<Void>

Loads the structure blocks and entities from the given source and places the blocks at the defined position.

loadFromWorld

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

Loads the structure blocks and entities from the structure storage inside each world folder of Minecraft and places the blocks at the defined position.

mirror

abstract fun mirror(mirror: StructureMirror): StructureLoaderAbstract<L, V, B, E, W>

Sets the target mirror type.

onProcessBlock

abstract fun onProcessBlock(onStructurePlace: (StructurePlacePart<B, W>) -> Boolean): StructureLoaderAbstract<L, V, B, E, W>

Attaches a new function to the structure processor which is called for each block being placed in the world.

onProcessEntity

abstract fun onProcessEntity(onStructurePlace: (StructureEntity<E, L>) -> Boolean): StructureLoaderAbstract<L, V, B, E, W>

Attaches a new function to the structure processor which is called for each entity being placed in the world.

rotation

abstract fun rotation(rotation: StructureRotation): StructureLoaderAbstract<L, V, B, E, W>

Sets the target rotation type.

seed

abstract fun seed(seed: Long): StructureLoaderAbstract<L, V, B, E, W>

Sets the target seed.