Package org.spongepowered.api.block.entity

Interface Sign

All Superinterfaces:

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

public interface Sign
extends BlockEntity, Nameable

Represents a sign.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Sign.SignText

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 Sign.SignText	backText()	Gets the back side Sign.SignText
default Sign.SignText	frontText()	Gets the front side Sign.SignText
default Value.Mutable<Boolean>	glowingText()	Gets whether the front side Sign.SignText has glowing text
default ListValue.Mutable<Component>	lines()	Gets the ListValue.Mutable of Component for the Sign to show.
default Value.Mutable<Boolean>	waxed()	Gets whether this sign is waxed.

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

block, copy, createArchetype, isRemoved, locatableBlock, mirror, mirror, remove, rotate, rotate, 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.util.Nameable

name

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

lines

default ListValue.Mutable<Component> lines()

Gets the ListValue.Mutable of Component for the Sign to show.

Returns:

The list of text lines

glowingText

default Value.Mutable<Boolean> glowingText()

Gets whether the front side Sign.SignText has glowing text

Returns:

Whether this sign has glowing text

waxed

default Value.Mutable<Boolean> waxed()

Gets whether this sign is waxed.

Returns:

true when this sign is waxed.

backText

default Sign.SignText backText()

Gets the back side Sign.SignText

Returns:

the back side sign-text

frontText

default Sign.SignText frontText()

Gets the front side Sign.SignText

Returns:

the back side sign-text