com.destroystokyo.paper

Class Title.Builder

java.lang.Object

com.destroystokyo.paper.Title.Builder

Enclosing class:

Title

public static final class Title.Builder
extends Object

A builder for creating titles

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Title	build() Create a title based on the values in the builder.
Title.Builder	fadeIn(int fadeIn) Sets the number of ticks for the title to fade in
Title.Builder	fadeOut(int fadeOut) Sets the number of ticks for the title to fade out.
Title.Builder	stay(int stay) Sets the number of ticks for the title to stay.
Title.Builder	subtitle(net.md_5.bungee.api.chat.BaseComponent subtitle) Sets the subtitle to the given text.
Title.Builder	subtitle(net.md_5.bungee.api.chat.BaseComponent[] subtitle) Sets the subtitle to the given text.
Title.Builder	subtitle(String subtitle) Sets the subtitle to the given text.
Title.Builder	title(net.md_5.bungee.api.chat.BaseComponent title) Sets the title to the given text.
Title.Builder	title(net.md_5.bungee.api.chat.BaseComponent[] title) Sets the title to the given text.
Title.Builder	title(String title) Sets the title to the given text.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

title

public Title.Builder title(net.md_5.bungee.api.chat.BaseComponent title)

Sets the title to the given text.

Parameters:

title - the title text

Returns:

this builder instance

Throws:

NullPointerException - if the title is null

title

public Title.Builder title(net.md_5.bungee.api.chat.BaseComponent[] title)

Sets the title to the given text.

Parameters:

title - the title text

Returns:

this builder instance

Throws:

NullPointerException - if the title is null

title

public Title.Builder title(String title)

Sets the title to the given text.

It is recommended to the BaseComponent methods.

Parameters:

title - the title text

Returns:

this builder instance

Throws:

NullPointerException - if the title is null

subtitle

public Title.Builder subtitle(net.md_5.bungee.api.chat.BaseComponent subtitle)

Sets the subtitle to the given text.

Parameters:

subtitle - the title text

Returns:

this builder instance

subtitle

public Title.Builder subtitle(net.md_5.bungee.api.chat.BaseComponent[] subtitle)

Sets the subtitle to the given text.

Parameters:

subtitle - the title text

Returns:

this builder instance

subtitle

public Title.Builder subtitle(String subtitle)

Sets the subtitle to the given text.

It is recommended to the BaseComponent methods.

Parameters:

subtitle - the title text

Returns:

this builder instance

fadeIn

public Title.Builder fadeIn(int fadeIn)

Sets the number of ticks for the title to fade in

Parameters:

fadeIn - the number of ticks to fade in

Returns:

this builder instance

Throws:

IllegalArgumentException - if it is negative

stay

public Title.Builder stay(int stay)

Sets the number of ticks for the title to stay.

Parameters:

stay - the number of ticks to stay

Returns:

this builder instance

Throws:

IllegalArgumentException - if it is negative

fadeOut

public Title.Builder fadeOut(int fadeOut)

Sets the number of ticks for the title to fade out.

Parameters:

fadeOut - the number of ticks to fade out

Returns:

this builder instance

Throws:

IllegalArgumentException - if it is negative

build

public Title build()

Create a title based on the values in the builder.

Returns:

a title from the values in this builder

Throws:

IllegalStateException - if title isn't specified