Class TextTitle
- java.lang.Object
-
- com.velocitypowered.api.util.title.TextTitle
-
- All Implemented Interfaces:
Title
@Deprecated public final class TextTitle extends Object implements Title
Deprecated.Replaced withTitleRepresents a "full" title, including all components. This class is immutable.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTextTitle.BuilderDeprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleanareTimesSet()Deprecated.Determines whether or not this title has times set on it.static TextTitle.Builderbuilder()Deprecated.Creates a new builder for constructing titles.booleanequals(@Nullable Object o)Deprecated.intgetFadeIn()Deprecated.Returns the number of ticks over which this title will fade in.intgetFadeOut()Deprecated.Returns the number of ticks over which this title will fade out.intgetStay()Deprecated.Returns the number of ticks this title will stay up.Optional<net.kyori.text.Component>getSubtitle()Deprecated.Returns the subtitle this title has, if any.Optional<net.kyori.text.Component>getTitle()Deprecated.Returns the main title this title has, if any.inthashCode()Deprecated.booleanisResetBeforeSend()Deprecated.Returns whether or not a reset packet will be sent before this title is sent.TextTitle.BuildertoBuilder()Deprecated.Creates a new builder from the contents of this title so that it may be changed.StringtoString()Deprecated.
-
-
-
Method Detail
-
getTitle
public Optional<net.kyori.text.Component> getTitle()
Deprecated.Returns the main title this title has, if any.- Returns:
- the main title of this title
-
getSubtitle
public Optional<net.kyori.text.Component> getSubtitle()
Deprecated.Returns the subtitle this title has, if any.- Returns:
- the subtitle
-
getStay
public int getStay()
Deprecated.Returns the number of ticks this title will stay up.- Returns:
- how long the title will stay, in ticks
-
getFadeIn
public int getFadeIn()
Deprecated.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()
Deprecated.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()
Deprecated.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()
Deprecated.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()
Deprecated.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
-
builder
public static TextTitle.Builder builder()
Deprecated.Creates a new builder for constructing titles.- Returns:
- a builder for constructing titles
-
-