Interface TextDisplay
- All Superinterfaces:
CopyableDataHolder
,DataHolder
,DataHolder.Mutable
,DataSerializable
,DisplayEntity
,Entity
,EntityProjectileSource
,HoverEventSource<HoverEvent.ShowEntity>
,Identifiable
,Locatable
,ProjectileSource
,RandomProvider
,SerializableDataHolder
,SerializableDataHolder.Mutable
,Sound.Emitter
,TeamMember
,ValueContainer
-
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 TypeMethodDescriptiondefault Color
Gets the background color of the displayed text.default boolean
Checks if the displayed text is visible through blocks.default boolean
Gets the background color of the displayed text.default Component
Returns the displayed textdefault boolean
Checks if the displayed text has a shadow.default int
Gets the maximum line width used to split lines of text.default TextAlignment
Gets the alignment direction of the displayed text.default int
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, teleportDuration, 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, frozenTime, glowing, gravityAffected, height, invisible, invulnerabilityTicks, invulnerable, isLoaded, isRemoved, isTransient, lookAt, maxAir, maxFrozenTime, 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.scoreboard.TeamMember
teamRepresentation
-
Method Details
-
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
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
Gets the alignment direction of the displayed text.- Returns:
- The alignment direction of the displayed text
-