Package org.bukkit.entity

Interface TextDisplay

All Superinterfaces:

Audience, CommandSender, Display, Entity, HoverEventSource<HoverEvent.ShowEntity>, Metadatable, Nameable, Permissible, PersistentDataHolder, Pointered, ServerOperator, Sound.Emitter

public interface TextDisplay
extends Display

Represents a text display entity.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TextDisplay.TextAlignment	Represents possible text alignments for this display.

Nested classes/interfaces inherited from interface org.bukkit.entity.Display

Display.Billboard, Display.Brightness

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Entity.Spigot

Method Summary

Modifier and Type	Method	Description
@NotNull TextDisplay.TextAlignment	getAlignment()	Gets the text alignment for this display.
@Nullable Color	getBackgroundColor()	Deprecated. API subject to change
int	getLineWidth()	Gets the maximum line width before wrapping.
@Nullable String	getText()	Deprecated. in favour of text()
byte	getTextOpacity()	Gets the text opacity.
boolean	isDefaultBackground()	Gets if the text has its default background.
boolean	isSeeThrough()	Gets if the text is see through.
boolean	isShadowed()	Gets if the text is shadowed.
void	setAlignment(@NotNull TextDisplay.TextAlignment alignment)	Sets the text alignment for this display.
void	setBackgroundColor(@Nullable Color color)	Deprecated. API subject to change
void	setDefaultBackground(boolean defaultBackground)	Sets if the text has its default background.
void	setLineWidth(int width)	Sets the maximum line width before wrapping.
void	setSeeThrough(boolean seeThrough)	Sets if the text is see through.
void	setShadowed(boolean shadow)	Sets if the text is shadowed.
void	setText(@Nullable String text)	Deprecated. in favour of text(net.kyori.adventure.text.Component)
void	setTextOpacity(byte opacity)	Sets the text opacity.
@NotNull Component	text()	Gets the displayed text.
void	text(@Nullable Component text)	Sets the displayed text.

Methods inherited from interface net.kyori.adventure.audience.Audience

clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendTitlePart, showBossBar, showTitle, stopSound, stopSound

Methods inherited from interface org.bukkit.command.CommandSender

getName, name, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlainMessage, sendRichMessage, sendRichMessage

Methods inherited from interface org.bukkit.entity.Display

getBillboard, getBrightness, getDisplayHeight, getDisplayWidth, getGlowColorOverride, getInterpolationDelay, getInterpolationDuration, getShadowRadius, getShadowStrength, getTransformation, getViewRange, setBillboard, setBrightness, setDisplayHeight, setDisplayWidth, setGlowColorOverride, setInterpolationDelay, setInterpolationDuration, setShadowRadius, setShadowStrength, setTransformation, setTransformationMatrix, setViewRange

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, asHoverEvent, collidesAt, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPitch, getPortalCooldown, getPose, getScheduler, getScoreboardEntryName, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedPlayers, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, getX, getY, getYaw, getZ, hasFixedPose, hasGravity, isCustomNameVisible, isDead, isEmpty, isFreezeTickingLocked, isFrozen, isGlowing, isInBubbleColumn, isInLava, isInPowderedSnow, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isOnGround, isPersistent, isSilent, isSneaking, isTicking, isUnderWater, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, lockFreezeTicks, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setPose, setPose, setRotation, setSilent, setSneaking, setTicksLived, setVelocity, setVisibleByDefault, setVisualFire, spawnAt, spawnAt, spigot, teamDisplayName, teleport, teleport, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync, wouldCollideUsing

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

asHoverEvent

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface org.bukkit.permissions.Permissible

addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, permissionValue, permissionValue, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom, pointers

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Method Details

getText

@Nullable
@Deprecated
@Nullable String getText()

Deprecated.

in favour of text()

Gets the displayed text.

Returns:

the displayed text.

setText

@Deprecated
void setText(@Nullable
 @Nullable String text)

Deprecated.

in favour of text(net.kyori.adventure.text.Component)

Sets the displayed text.

Parameters:

text - the new text

text

@NotNull Component text()

Gets the displayed text.

Returns:

the displayed text

text

void text(@Nullable Component text)

Sets the displayed text.

Parameters:

text - the new text

getLineWidth

int getLineWidth()

Gets the maximum line width before wrapping.

Returns:

the line width

setLineWidth

void setLineWidth(int width)

Sets the maximum line width before wrapping.

Parameters:

width - new line width

getBackgroundColor

@Nullable
@Deprecated
@Nullable Color getBackgroundColor()

Deprecated.

API subject to change

Gets the text background color.

Returns:

the background color

setBackgroundColor

@Deprecated
void setBackgroundColor(@Nullable
 @Nullable Color color)

Deprecated.

API subject to change

Sets the text background color.

Parameters:

color - new background color

getTextOpacity

byte getTextOpacity()

Gets the text opacity.

Returns:

opacity or -1 if not set

setTextOpacity

void setTextOpacity(byte opacity)

Sets the text opacity.

Parameters:

opacity - new opacity or -1 if default

isShadowed

boolean isShadowed()

Gets if the text is shadowed.

Returns:

shadow status

setShadowed

void setShadowed(boolean shadow)

Sets if the text is shadowed.

Parameters:

shadow - if shadowed

isSeeThrough

boolean isSeeThrough()

Gets if the text is see through.

Returns:

see through status

setSeeThrough

void setSeeThrough(boolean seeThrough)

Sets if the text is see through.

Parameters:

seeThrough - if see through

isDefaultBackground

boolean isDefaultBackground()

Gets if the text has its default background.

Returns:

default background

setDefaultBackground

void setDefaultBackground(boolean defaultBackground)

Sets if the text has its default background.

Parameters:

defaultBackground - if default

getAlignment

@NotNull
@NotNull TextDisplay.TextAlignment getAlignment()

Gets the text alignment for this display.

Returns:

text alignment

setAlignment

void setAlignment(@NotNull
 @NotNull TextDisplay.TextAlignment alignment)

Sets the text alignment for this display.

Parameters:

alignment - new alignment