Package org.bukkit.entity

Interface Display

All Superinterfaces:

CommandSender, Entity, Metadatable, Nameable, Permissible, PersistentDataHolder, ServerOperator

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
Display.Billboard	getBillboard()	Gets the billboard setting of this entity.
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.
Color	getGlowColorOverride()	Gets the scoreboard team overridden glow color of this display.
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.
int	getTeleportDuration()	Gets the teleport duration of this display.
Transformation	getTransformation()	Gets the transformation applied to this display.
float	getViewRange()	Gets the view distance/range of this display.
void	setBillboard(Display.Billboard billboard)	Sets the billboard setting of this entity.
void	setBrightness(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(Color color)	Sets the scoreboard team overridden glow color of this display.
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	setTeleportDuration(int duration)	Sets the teleport duration of this display.
void	setTransformation(Transformation transformation)	Sets the transformation applied to this display
void	setTransformationMatrix(org.joml.Matrix4f transformationMatrix)	Sets the raw transformation matrix applied to this display
void	setViewRange(float range)	Sets the view distance/range of this display.

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, copy, copy, createSnapshot, eject, getAsString, getBoundingBox, getEntityId, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedBy, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isFrozen, isGlowing, isInsideVehicle, isInvulnerable, isInWater, isInWorld, isOnGround, isPersistent, isSilent, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, setVisibleByDefault, setVisualFire, spigot, teleport, teleport, teleport, teleport

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.Nameable

getCustomName, setCustomName

Methods inherited from interface org.bukkit.permissions.Permissible

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

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Method Details

getTransformation

@NotNull
Transformation getTransformation()

Gets the transformation applied to this display.

Returns:

the transformation

setTransformation

void setTransformation(@NotNull
 Transformation transformation)

Sets the transformation applied to this display

Parameters:

transformation - the new transformation

setTransformationMatrix

void setTransformationMatrix(@NotNull
 org.joml.Matrix4f transformationMatrix)

Sets the raw transformation matrix applied to this display

Parameters:

transformationMatrix - the transformation matrix

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

getTeleportDuration

int getTeleportDuration()

Gets the teleport duration of this display.

• 0 means that updates are applied immediately.
• 1 means that the display entity will move from current position to the updated one over one tick.
• Higher values spread the movement over multiple ticks.

Returns:

teleport duration

setTeleportDuration

void setTeleportDuration(int duration)

Sets the teleport duration of this display.

Parameters:

duration - new duration

Throws:

IllegalArgumentException - if duration is not between 0 and 59

See Also:

• getTeleportDuration()

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
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

void setBillboard(@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
Color getGlowColorOverride()

Gets the scoreboard team overridden glow color of this display.

Returns:

glow color

setGlowColorOverride

void setGlowColorOverride(@Nullable
 Color color)

Sets the scoreboard team overridden glow color of this display.

Parameters:

color - new color

getBrightness

@Nullable
Display.Brightness getBrightness()

Gets the brightness override of the entity.

Returns:

brightness override, if set

setBrightness

void setBrightness(@Nullable
 Display.Brightness brightness)

Sets the brightness override of the entity.

Parameters:

brightness - new brightness override