Package org.spongepowered.api.entity.display

Interface TextDisplay

All Superinterfaces:

CopyableDataHolder, DataHolder, DataHolder.Mutable, DataSerializable, DisplayEntity, Entity, EntityProjectileSource, HoverEventSource<HoverEvent.ShowEntity>, Identifiable, Locatable, ProjectileSource, RandomProvider, SerializableDataHolder, SerializableDataHolder.Mutable, Sound.Emitter, ValueContainer

public interface TextDisplay
extends DisplayEntity

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.util.RandomProvider

RandomProvider.Source

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 Color	backgroundColor()	Gets the background color of the displayed text.
default boolean	canSeeThroughBlocks()	Checks if the displayed text is visible through blocks.
default boolean	defaultBackground()	Gets the background color of the displayed text.
default Component	displayedText()	Returns the displayed text
default boolean	hasShadow()	Checks if the displayed text has a shadow.
default int	lineWidth()	Gets the maximum line width used to split lines of text.
default TextAlignment	textAlignment()	Gets the alignment direction of the displayed text.
default int	textOpacity()	Gets the opacity of the displayed text.

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.entity.display.DisplayEntity

billboardType, blockLight, interpolationDelay, interpolationDuration, shadowRadius, shadowStrength, skyLight, transform, viewRange

Methods inherited from interface org.spongepowered.api.entity.Entity

age, asHoverEvent, baseSize, baseVehicle, boundingBox, canSee, copy, createArchetype, createSnapshot, creator, customName, customNameVisible, damage, damage, direction, displayName, eyeHeight, eyePosition, fallDistance, fireImmuneTicks, fireTicks, glowing, gravityAffected, height, invisible, invulnerabilityTicks, invulnerable, isLoaded, isRemoved, isTransient, lookAt, maxAir, nearbyEntities, nearbyEntities, notifier, onGround, passengers, position, remainingAir, remove, rotation, scale, scoreboardTags, setLocation, setLocationAndRotation, setLocationAndRotation, setPosition, setRotation, setScale, setTransform, silent, sneaking, sprinting, swiftness, transferToWorld, transferToWorld, type, vanishState, vehicle, velocity, wet

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Methods inherited from interface org.spongepowered.api.util.Identifiable

uniqueId

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

blockPosition, location, serverLocation, world

Methods inherited from interface org.spongepowered.api.projectile.source.ProjectileSource

launchProjectile, launchProjectile, launchProjectile, launchProjectile, launchProjectileTo, launchProjectileTo

Methods inherited from interface org.spongepowered.api.util.RandomProvider

random

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

displayedText

default Component displayedText()

Returns the displayed text

Returns:

the displayed text

lineWidth

default int lineWidth()

Gets the maximum line width used to split lines of text.

Returns:

The maximum line width used to split lines of text

textOpacity

default int textOpacity()

Gets the opacity of the displayed text.

Returns:

The opacity of the displayed text

canSeeThroughBlocks

default boolean canSeeThroughBlocks()

Checks if the displayed text is visible through blocks.

Returns:

True if the displayed text is visible through blocks, false otherwise

hasShadow

default boolean hasShadow()

Checks if the displayed text has a shadow.

Returns:

True if the displayed text has a shadow, false otherwise

backgroundColor

default Color backgroundColor()

Gets the background color of the displayed text. Note that this supports alpha values.

Returns:

The background color of the displayed text

defaultBackground

default boolean defaultBackground()

Gets the background color of the displayed text.

Returns:

The background color of the displayed text

textAlignment

default TextAlignment textAlignment()

Gets the alignment direction of the displayed text.

Returns:

The alignment direction of the displayed text