Package me.totalfreedom.display

Class TitleDisplay

java.lang.Object

me.totalfreedom.display.TitleDisplay

public class TitleDisplay
extends Object

A wrapper class for Titles that allows for easy display to an Audience.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TitleDisplay.TitleBuilder	A builder class for Titles.

Constructor Summary

Constructors

Constructor	Description
TitleDisplay(net.kyori.adventure.title.Title title)	Creates a new TitleDisplay with the given Title.

Method Summary

Modifier and Type	Method	Description
static TitleDisplay.TitleBuilder	builder()
void	displayForwarded(net.kyori.adventure.audience.ForwardingAudience forwardingAudience)	Displays the Title to the given ForwardingAudience.
void	displayTo(net.kyori.adventure.audience.Audience audience)	Displays the Title to the given Audience.
net.kyori.adventure.title.Title	getTitle()
void	setTitle(net.kyori.adventure.title.Title title)	Sets the Title to display.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TitleDisplay

public TitleDisplay(net.kyori.adventure.title.Title title)

Creates a new TitleDisplay with the given Title.

Parameters:

title - The Title to display.

Method Details

builder

public static TitleDisplay.TitleBuilder builder()

Returns:

A new TitleDisplay.TitleBuilder which can be used to create new Titles.

displayTo

public void displayTo(net.kyori.adventure.audience.Audience audience)

Displays the Title to the given Audience.

Parameters:

audience - The Audience to display the Title to.

getTitle

public net.kyori.adventure.title.Title getTitle()

Returns:

The Title to display.

setTitle

public void setTitle(net.kyori.adventure.title.Title title)

Sets the Title to display.

Parameters:

title - The Title to display.

displayForwarded

public void displayForwarded(net.kyori.adventure.audience.ForwardingAudience forwardingAudience)

Displays the Title to the given ForwardingAudience.

Parameters:

forwardingAudience - The ForwardingAudience to display the Title to.