Package io.github.projectunified.unihologram.api.display

Interface DisplayHologram<T>

Type Parameters:

T - the type of the location

All Superinterfaces:

Hologram<T>

All Known Implementing Classes:

FHHologram

public interface DisplayHologram<T>
extends Hologram<T>

The Hologram that uses the new Minecraft TextDisplay API. Note that the location is at the bottom of the hologram. Users should check if the hologram is a DisplayHologram before working with location.

Method Summary

Modifier and Type	Method	Description
DisplayTextAlignment	getAlignment()	Get the text alignment
Color	getBackgroundColor()	Get the background color
DisplayBillboard	getBillboard()	Get the billboard
DisplayScale	getScale()	Get the scale of the text
float	getShadowRadius()	Get the shadow radius
float	getShadowStrength()	Get the shadow strength
boolean	isShadowed()	Get if the text is shadowed
void	setAlignment(DisplayTextAlignment alignment)	Set the text alignment
void	setBackgroundColor(Color color)	Set the background color
void	setBillboard(DisplayBillboard billboard)	Set the billboard
void	setScale(DisplayScale scale)	Set the scale of the text
void	setShadowed(boolean shadowed)	Set if the text is shadowed
void	setShadowRadius(float radius)	Set the shadow radius
void	setShadowStrength(float strength)	Set the shadow strength

Methods inherited from interface io.github.projectunified.unihologram.api.Hologram

addLine, clear, getLine, getLines, getLocation, getName, init, insertLine, isInitialized, removeLine, setLine, setLines, setLocation, size

Method Details

getBackgroundColor

Color getBackgroundColor()

Get the background color

Returns:

the background color

setBackgroundColor

void setBackgroundColor(Color color)

Set the background color

Parameters:

color - the background color

getScale

DisplayScale getScale()

Get the scale of the text

Returns:

the scale

setScale

void setScale(DisplayScale scale)

Set the scale of the text

Parameters:

scale - the scale

getShadowRadius

float getShadowRadius()

Get the shadow radius

Returns:

the shadow radius

setShadowRadius

void setShadowRadius(float radius)

Set the shadow radius

Parameters:

radius - the shadow radius

getShadowStrength

float getShadowStrength()

Get the shadow strength

Returns:

the shadow strength

setShadowStrength

void setShadowStrength(float strength)

Set the shadow strength

Parameters:

strength - the shadow strength

isShadowed

boolean isShadowed()

Get if the text is shadowed

Returns:

true if it is

setShadowed

void setShadowed(boolean shadowed)

Set if the text is shadowed

Parameters:

shadowed - true if it is

getBillboard

DisplayBillboard getBillboard()

Get the billboard

Returns:

the billboard

setBillboard

void setBillboard(DisplayBillboard billboard)

Set the billboard

Parameters:

billboard - the billboard

getAlignment

DisplayTextAlignment getAlignment()

Get the text alignment

Returns:

the text alignment

setAlignment

void setAlignment(DisplayTextAlignment alignment)

Set the text alignment

Parameters:

alignment - the text alignment