Package me.totalfreedom.display

Class TitleDisplay.TitleBuilder

java.lang.Object

me.totalfreedom.display.TitleDisplay.TitleBuilder

Enclosing class:

TitleDisplay

public static final class TitleDisplay.TitleBuilder
extends Object

A builder class for Titles.

Constructor Summary

Constructors

Constructor	Description
TitleBuilder()	Creates a new TitleDisplay.TitleBuilder with default values.

Method Summary

Modifier and Type	Method	Description
net.kyori.adventure.title.Title	build()	Builds the Title with the given parameters.
TitleDisplay.TitleBuilder	setDisplayDuration(Duration duration)	Sets the display duration of the Title.
TitleDisplay.TitleBuilder	setFadeIn(Duration duration)	Sets the fade in time of the Title.
TitleDisplay.TitleBuilder	setFadeOut(Duration duration)	Sets the fade out time of the Title.
TitleDisplay.TitleBuilder	setMainTitle(String title)	Sets the main title of the Title.
TitleDisplay.TitleBuilder	setMainTitle(String title, net.kyori.adventure.text.format.TextColor titleColor)	Sets the main title of the Title.
TitleDisplay.TitleBuilder	setMainTitle(net.kyori.adventure.text.Component mainTitle)	Sets the main title of the Title.
TitleDisplay.TitleBuilder	setSubTitle(String title)	Sets the subtitle of the Title.
TitleDisplay.TitleBuilder	setSubTitle(String title, net.kyori.adventure.text.format.TextColor titleColor)	Sets the subtitle of the Title.
TitleDisplay.TitleBuilder	setSubTitle(net.kyori.adventure.text.Component subTitle)	Sets the subtitle of the Title.

Methods inherited from class java.lang.Object

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

Constructor Details

TitleBuilder

public TitleBuilder()

Creates a new TitleDisplay.TitleBuilder with default values. The default values are:

• Empty main title
• Empty subtitle
• Default fade in time
• Default fade out time
• Default display duration

See Also:

• Title.DEFAULT_TIMES

Method Details

setMainTitle

public TitleDisplay.TitleBuilder setMainTitle(String title)

Sets the main title of the Title.

Parameters:

title - The main title of the Title.

Returns:

The TitleDisplay.TitleBuilder instance.

setMainTitle

public TitleDisplay.TitleBuilder setMainTitle(String title,
 net.kyori.adventure.text.format.TextColor titleColor)

Sets the main title of the Title.

Parameters:

title - The main title of the Title.

titleColor - The color of the main title.

Returns:

The TitleDisplay.TitleBuilder instance.

setMainTitle

public TitleDisplay.TitleBuilder setMainTitle(net.kyori.adventure.text.Component mainTitle)

Sets the main title of the Title.

Parameters:

mainTitle - The main title of the Title.

Returns:

The TitleDisplay.TitleBuilder instance.

setSubTitle

public TitleDisplay.TitleBuilder setSubTitle(String title)

Sets the subtitle of the Title.

Parameters:

title - The subtitle of the Title.

Returns:

The TitleDisplay.TitleBuilder instance.

setSubTitle

public TitleDisplay.TitleBuilder setSubTitle(String title,
 net.kyori.adventure.text.format.TextColor titleColor)

Sets the subtitle of the Title.

Parameters:

title - The subtitle of the Title.

titleColor - The color of the subtitle.

Returns:

The TitleDisplay.TitleBuilder instance.

setSubTitle

public TitleDisplay.TitleBuilder setSubTitle(net.kyori.adventure.text.Component subTitle)

Sets the subtitle of the Title.

Parameters:

subTitle - The subtitle of the Title.

Returns:

The TitleDisplay.TitleBuilder instance.

setFadeIn

public TitleDisplay.TitleBuilder setFadeIn(Duration duration)

Sets the fade in time of the Title.

Parameters:

duration - The fade in time of the Title.

Returns:

The TitleDisplay.TitleBuilder instance.

setFadeOut

public TitleDisplay.TitleBuilder setFadeOut(Duration duration)

Sets the fade out time of the Title.

Parameters:

duration - The fade out time of the Title.

Returns:

The TitleDisplay.TitleBuilder instance.

setDisplayDuration

public TitleDisplay.TitleBuilder setDisplayDuration(Duration duration)

Sets the display duration of the Title.

Parameters:

duration - The display duration of the Title.

Returns:

The TitleDisplay.TitleBuilder instance.

build

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

Builds the Title with the given parameters.

Returns:

The built Title.