Package org.spongepowered.api.block.entity

Interface StructureBlock

All Superinterfaces:

BlockEntity, CopyableDataHolder, DataHolder, DataHolder.Mutable, DataSerializable, Locatable, SerializableDataHolder, SerializableDataHolder.Mutable, ValueContainer

public interface StructureBlock
extends BlockEntity

Represents a StructureBlock.

StructureBlock blocks can be used to save and load structures, alongside structure void blocks.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Nested classes/interfaces inherited from interface org.spongepowered.api.data.SerializableDataHolder

SerializableDataHolder.Immutable<I extends SerializableDataHolder.Immutable<I>>, SerializableDataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
default Optional<Value.Mutable<String>>	author()	Keys.STRUCTURE_AUTHOR
default Value.Mutable<Boolean>	ignoreEntities()	Keys.STRUCTURE_IGNORE_ENTITIES
default Value.Mutable<Double>	integrity()	Keys.STRUCTURE_INTEGRITY
default Value.Mutable<StructureMode>	mode()	Keys.STRUCTURE_MODE
default Value.Mutable<Vector3i>	position()	Keys.STRUCTURE_POSITION
default Value.Mutable<Boolean>	powered()	Keys.STRUCTURE_POWERED
default Value.Mutable<Long>	seed()	Keys.STRUCTURE_SEED
default Value.Mutable<Boolean>	showAir()	Keys.STRUCTURE_SHOW_AIR
default Value.Mutable<Boolean>	showBoundingBox()	Keys.STRUCTURE_SHOW_BOUNDING_BOX
default Value.Mutable<Vector3i>	size()	Keys.STRUCTURE_SIZE

Methods inherited from interface org.spongepowered.api.block.entity.BlockEntity

block, copy, createArchetype, isValid, locatableBlock, mirror, mirror, rotate, rotate, setValid, type

Methods inherited from interface org.spongepowered.api.data.DataHolder.Mutable

copyFrom, copyFrom, offer, offer, offer, offer, offerAll, offerAll, offerAll, offerAll, offerAll, offerAll, offerSingle, offerSingle, offerSingle, offerSingle, remove, remove, remove, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeKey, removeKey, removeSingle, removeSingle, transform, transform, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Methods inherited from interface org.spongepowered.api.world.Locatable

blockPosition, location, serverLocation, world

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder

validateRawData

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder.Mutable

setRawData

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Details

mode

default Value.Mutable<StructureMode> mode()

Keys.STRUCTURE_MODE

Returns:

The structure mode of this structure block.

powered

default Value.Mutable<Boolean> powered()

Keys.STRUCTURE_POWERED

Returns:

Whether this structure block is powered.

showBoundingBox

default Value.Mutable<Boolean> showBoundingBox()

Keys.STRUCTURE_SHOW_BOUNDING_BOX

In vanilla, this is only visible to Players whose GameMode is GameModes.CREATIVE or GameModes.SPECTATOR.

Returns:

Whether the bounding box should be visible.

showAir

default Value.Mutable<Boolean> showAir()

Keys.STRUCTURE_SHOW_AIR

Returns:

Whether the air within the structure should be visible.

ignoreEntities

default Value.Mutable<Boolean> ignoreEntities()

Keys.STRUCTURE_IGNORE_ENTITIES

Returns:

Whether this structure block should ignore entities.

size

default Value.Mutable<Vector3i> size()

Keys.STRUCTURE_SIZE

Returns:

The size of the structure.

position

default Value.Mutable<Vector3i> position()

Keys.STRUCTURE_POSITION

Returns:

The position of the structure.

seed

default Value.Mutable<Long> seed()

Keys.STRUCTURE_SEED

Returns:

The seed of the structure to be generated.

integrity

default Value.Mutable<Double> integrity()

Keys.STRUCTURE_INTEGRITY

Returns:

The integrity of the structure.

author

default Optional<Value.Mutable<String>> author()

Keys.STRUCTURE_AUTHOR

Returns:

The author of the structure loaded by the structure block.