com.destroystokyo.paper

Class Title

java.lang.Object

com.destroystokyo.paper.Title

public final class Title
extends Object

Represents a title to may be sent to a Player.

A title can be sent without subtitle text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Title.Builder A builder for creating titles

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FADE_IN The default number of ticks for the title to fade in.
static int	DEFAULT_FADE_OUT The default number of ticks for the title to fade out.
static int	DEFAULT_STAY The default number of ticks for the title to stay.

Constructor Summary

Constructors

Constructor and Description
Title(net.md_5.bungee.api.chat.BaseComponent title) Create a title with the default time values and no subtitle.
Title(net.md_5.bungee.api.chat.BaseComponent[] title) Create a title with the default time values and no subtitle.
Title(net.md_5.bungee.api.chat.BaseComponent[] title, net.md_5.bungee.api.chat.BaseComponent[] subtitle) Create a title with the default time values.
Title(net.md_5.bungee.api.chat.BaseComponent[] title, net.md_5.bungee.api.chat.BaseComponent[] subtitle, int fadeIn, int stay, int fadeOut) Creates a new title.
Title(net.md_5.bungee.api.chat.BaseComponent title, net.md_5.bungee.api.chat.BaseComponent subtitle) Create a title with the default time values.
Title(net.md_5.bungee.api.chat.BaseComponent title, net.md_5.bungee.api.chat.BaseComponent subtitle, int fadeIn, int stay, int fadeOut) Creates a new title.
Title(String title) Create a title with the default time values and no subtitle.
Title(String title, String subtitle) Create a title with the default time values.
Title(String title, String subtitle, int fadeIn, int stay, int fadeOut) Creates a new title.

Method Summary

Modifier and Type	Method and Description
static Title.Builder	builder()
int	getFadeIn() Gets the number of ticks to fade in.
int	getFadeOut() Gets the number of ticks to fade out.
int	getStay() Gets the number of ticks to stay.
net.md_5.bungee.api.chat.BaseComponent[]	getSubtitle() Gets the text of this title's subtitle
net.md_5.bungee.api.chat.BaseComponent[]	getTitle() Gets the text of this title

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FADE_IN

public static final int DEFAULT_FADE_IN

The default number of ticks for the title to fade in.

See Also:

Constant Field Values

DEFAULT_STAY

public static final int DEFAULT_STAY

The default number of ticks for the title to stay.

See Also:

Constant Field Values

DEFAULT_FADE_OUT

public static final int DEFAULT_FADE_OUT

The default number of ticks for the title to fade out.

See Also:

Constant Field Values

Constructor Detail

Title

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

Create a title with the default time values and no subtitle.

Times use default values.

Parameters:

title - the main text of the title

Throws:

NullPointerException - if the title is null

Title

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

Create a title with the default time values and no subtitle.

Times use default values.

Parameters:

title - the main text of the title

Throws:

NullPointerException - if the title is null

Title

public Title(@NotNull
             String title)

Create a title with the default time values and no subtitle.

Times use default values.

Parameters:

title - the main text of the title

Throws:

NullPointerException - if the title is null

Title

public Title(@NotNull
             net.md_5.bungee.api.chat.BaseComponent title,
             @Nullable
             net.md_5.bungee.api.chat.BaseComponent subtitle)

Create a title with the default time values.

Times use default values.

Parameters:

title - the main text of the title

subtitle - the secondary text of the title

Title

public Title(@NotNull
             net.md_5.bungee.api.chat.BaseComponent[] title,
             @Nullable
             net.md_5.bungee.api.chat.BaseComponent[] subtitle)

Create a title with the default time values.

Times use default values.

Parameters:

title - the main text of the title

subtitle - the secondary text of the title

Title

public Title(@NotNull
             String title,
             @Nullable
             String subtitle)

Create a title with the default time values.

Times use default values.

Parameters:

title - the main text of the title

subtitle - the secondary text of the title

Title

public Title(@NotNull
             net.md_5.bungee.api.chat.BaseComponent title,
             @Nullable
             net.md_5.bungee.api.chat.BaseComponent subtitle,
             int fadeIn,
             int stay,
             int fadeOut)

Creates a new title.

Parameters:

title - the main text of the title

subtitle - the secondary text of the title

fadeIn - the number of ticks for the title to fade in

stay - the number of ticks for the title to stay on screen

fadeOut - the number of ticks for the title to fade out

Throws:

IllegalArgumentException - if any of the times are negative

Title

public Title(@Nullable
             net.md_5.bungee.api.chat.BaseComponent[] title,
             @NotNull
             net.md_5.bungee.api.chat.BaseComponent[] subtitle,
             int fadeIn,
             int stay,
             int fadeOut)

Creates a new title.

Parameters:

title - the main text of the title

subtitle - the secondary text of the title

fadeIn - the number of ticks for the title to fade in

stay - the number of ticks for the title to stay on screen

fadeOut - the number of ticks for the title to fade out

Throws:

IllegalArgumentException - if any of the times are negative

Title

public Title(@NotNull
             String title,
             @Nullable
             String subtitle,
             int fadeIn,
             int stay,
             int fadeOut)

Creates a new title.

It is recommended to the BaseComponent constrctors.

Parameters:

title - the main text of the title

subtitle - the secondary text of the title

fadeIn - the number of ticks for the title to fade in

stay - the number of ticks for the title to stay on screen

fadeOut - the number of ticks for the title to fade out

Method Detail

getTitle

@NotNull
public net.md_5.bungee.api.chat.BaseComponent[] getTitle()

Gets the text of this title

Returns:

the text

getSubtitle

@Nullable
public net.md_5.bungee.api.chat.BaseComponent[] getSubtitle()

Gets the text of this title's subtitle

Returns:

the text

getFadeIn

public int getFadeIn()

Gets the number of ticks to fade in.

The returned value is never negative.

Returns:

the number of ticks to fade in

getStay

public int getStay()

Gets the number of ticks to stay.

The returned value is never negative.

Returns:

the number of ticks to stay

getFadeOut

public int getFadeOut()

Gets the number of ticks to fade out.

The returned value is never negative.

Returns:

the number of ticks to fade out

builder

@NotNull
public static Title.Builder builder()