Package org.bukkit.entity

Interface Display

All Superinterfaces:

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

All Known Subinterfaces:

BlockDisplay, ItemDisplay, TextDisplay

public interface Display
extends Entity

Represents a display entity which is designed to only have a visual function.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Display.Billboard	Describes the axes/points around which the entity can pivot.
static class	Display.Brightness	Represents the brightness rendering parameters of the entity.

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

Entity.Spigot

Method Summary

Modifier and Type	Method	Description
@NotNull Display.Billboard	getBillboard()	Gets the billboard setting of this entity.
@Nullable Display.Brightness	getBrightness()	Gets the brightness override of the entity.
float	getDisplayHeight()	Gets the height of this display.
float	getDisplayWidth()	Gets the width of this display.
@Nullable Color	getGlowColorOverride()	Deprecated. API subject to change
int	getInterpolationDelay()	Gets the amount of ticks before client-side interpolation will commence.
int	getInterpolationDuration()	Gets the interpolation duration of this display.
float	getShadowRadius()	Gets the shadow radius of this display.
float	getShadowStrength()	Gets the shadow strength of this display.
@NotNull Transformation	getTransformation()	Gets the transformation applied to this display.
float	getViewRange()	Gets the view distance/range of this display.
void	setBillboard(@NotNull Display.Billboard billboard)	Sets the billboard setting of this entity.
void	setBrightness(@Nullable Display.Brightness brightness)	Sets the brightness override of the entity.
void	setDisplayHeight(float height)	Sets the height if this display.
void	setDisplayWidth(float width)	Sets the width of this display.
void	setGlowColorOverride(@Nullable Color color)	Deprecated. API subject to change
void	setInterpolationDelay(int ticks)	Sets the amount of ticks before client-side interpolation will commence.
void	setInterpolationDuration(int duration)	Sets the interpolation duration of this display.
void	setShadowRadius(float radius)	Sets the shadow radius of this display.
void	setShadowStrength(float strength)	Sets the shadow strength of this display.
void	setTransformation(@NotNull Transformation transformation)	Sets the transformation applied to this display
void	setViewRange(float range)	Sets the view distance/range of this display.

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

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, getPortalCooldown, getPose, getScheduler, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedPlayers, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, 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, 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

getTransformation

@NotNull
@NotNull Transformation getTransformation()

Gets the transformation applied to this display.

Returns:

the transformation

setTransformation

void setTransformation(@NotNull
 @NotNull Transformation transformation)

Sets the transformation applied to this display

Parameters:

transformation - the new transformation

getInterpolationDuration

int getInterpolationDuration()

Gets the interpolation duration of this display.

Returns:

interpolation duration

setInterpolationDuration

void setInterpolationDuration(int duration)

Sets the interpolation duration of this display.

Parameters:

duration - new duration

getViewRange

float getViewRange()

Gets the view distance/range of this display.

Returns:

view range

setViewRange

void setViewRange(float range)

Sets the view distance/range of this display.

Parameters:

range - new range

getShadowRadius

float getShadowRadius()

Gets the shadow radius of this display.

Returns:

radius

setShadowRadius

void setShadowRadius(float radius)

Sets the shadow radius of this display.

Parameters:

radius - new radius

getShadowStrength

float getShadowStrength()

Gets the shadow strength of this display.

Returns:

shadow strength

setShadowStrength

void setShadowStrength(float strength)

Sets the shadow strength of this display.

Parameters:

strength - new strength

getDisplayWidth

float getDisplayWidth()

Gets the width of this display.

Returns:

width

setDisplayWidth

void setDisplayWidth(float width)

Sets the width of this display.

Parameters:

width - new width

getDisplayHeight

float getDisplayHeight()

Gets the height of this display.

Returns:

height

setDisplayHeight

void setDisplayHeight(float height)

Sets the height if this display.

Parameters:

height - new height

getInterpolationDelay

int getInterpolationDelay()

Gets the amount of ticks before client-side interpolation will commence.

Returns:

interpolation delay ticks

setInterpolationDelay

void setInterpolationDelay(int ticks)

Sets the amount of ticks before client-side interpolation will commence.

Parameters:

ticks - interpolation delay ticks

getBillboard

@NotNull
@NotNull Display.Billboard getBillboard()

Gets the billboard setting of this entity. The billboard setting controls the automatic rotation of the entity to face the player.

Returns:

billboard setting

setBillboard

@NotNull
void setBillboard(@NotNull
 @NotNull Display.Billboard billboard)

Sets the billboard setting of this entity. The billboard setting controls the automatic rotation of the entity to face the player.

Parameters:

billboard - new setting

getGlowColorOverride

@Nullable
@Deprecated
@Nullable Color getGlowColorOverride()

Deprecated.

API subject to change

Gets the scoreboard team overridden glow color of this display.

Returns:

glow color

setGlowColorOverride

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

Deprecated.

API subject to change

Sets the scoreboard team overridden glow color of this display.

Parameters:

color - new color

getBrightness

@Nullable
@Nullable Display.Brightness getBrightness()

Gets the brightness override of the entity.

Returns:

brightness override, if set

setBrightness

void setBrightness(@Nullable
 @Nullable Display.Brightness brightness)

Sets the brightness override of the entity.

Parameters:

brightness - new brightness override