com.velocitypowered.api.util.title

Class TextTitle

java.lang.Object

com.velocitypowered.api.util.title.TextTitle

All Implemented Interfaces:

Title

public final class TextTitle
extends Object
implements Title

Represents a "full" title, including all components. This class is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextTitle.Builder

Method Summary

Modifier and Type	Method and Description
boolean	areTimesSet() Determines whether or not this title has times set on it.
static TextTitle.Builder	builder() Creates a new builder for constructing titles.
boolean	equals(@Nullable Object o)
int	getFadeIn() Returns the number of ticks over which this title will fade in.
int	getFadeOut() Returns the number of ticks over which this title will fade out.
int	getStay() Returns the number of ticks this title will stay up.
Optional<Component>	getSubtitle() Returns the subtitle this title has, if any.
Optional<Component>	getTitle() Returns the main title this title has, if any.
int	hashCode()
boolean	isResetBeforeSend() Returns whether or not a reset packet will be sent before this title is sent.
TextTitle.Builder	toBuilder() Creates a new builder from the contents of this title so that it may be changed.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTitle

public Optional<Component> getTitle()

Returns the main title this title has, if any.

Returns:

the main title of this title

getSubtitle

public Optional<Component> getSubtitle()

Returns the subtitle this title has, if any.

Returns:

the subtitle

getStay

public int getStay()

Returns the number of ticks this title will stay up.

Returns:

how long the title will stay, in ticks

getFadeIn

public int getFadeIn()

Returns the number of ticks over which this title will fade in.

Returns:

how long the title will fade in, in ticks

getFadeOut

public int getFadeOut()

Returns the number of ticks over which this title will fade out.

Returns:

how long the title will fade out, in ticks

isResetBeforeSend

public boolean isResetBeforeSend()

Returns whether or not a reset packet will be sent before this title is sent. By default, unless explicitly disabled, this is enabled by default.

Returns:

whether or not a reset packet will be sent before this title is sent

areTimesSet

public boolean areTimesSet()

Determines whether or not this title has times set on it. If none are set, it will update the previous title set on the client.

Returns:

whether or not this title has times set on it

toBuilder

public TextTitle.Builder toBuilder()

Creates a new builder from the contents of this title so that it may be changed.

Returns:

a builder instance with the contents of this title

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static TextTitle.Builder builder()

Creates a new builder for constructing titles.

Returns:

a builder for constructing titles