Package com.destroystokyo.paper
Class Title
java.lang.Object
com.destroystokyo.paper.Title
Deprecated.
Represents a title to may be sent to a
Player
.
A title can be sent without subtitle text.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Deprecated.A builder for creating titles -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Deprecated.The default number of ticks for the title to fade in.static final int
Deprecated.The default number of ticks for the title to fade out.static final int
Deprecated.The default number of ticks for the title to stay. -
Constructor Summary
ConstructorDescriptionDeprecated.Create a title with the default time values and no subtitle.Deprecated.Create a title with the default time values.Deprecated.Creates a new title.Deprecated.Create a title with the default time values and no subtitle.Deprecated.Create a title with the default time values and no subtitle.Title
(@NotNull net.md_5.bungee.api.chat.BaseComponent[] title, @Nullable net.md_5.bungee.api.chat.BaseComponent[] subtitle) Deprecated.Create a title with the default time values.Title
(@NotNull net.md_5.bungee.api.chat.BaseComponent title, @Nullable net.md_5.bungee.api.chat.BaseComponent subtitle) Deprecated.Create a title with the default time values.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) Deprecated.Creates a new title.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) Deprecated.Creates a new title. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.Sends the title directly to all online playersstatic @NotNull Title.Builder
builder()
Deprecated.int
Deprecated.Gets the number of ticks to fade in.int
Deprecated.Gets the number of ticks to fade out.int
getStay()
Deprecated.Gets the number of ticks to stay.@Nullable net.md_5.bungee.api.chat.BaseComponent[]
Deprecated.Gets the text of this title's subtitle@NotNull net.md_5.bungee.api.chat.BaseComponent[]
getTitle()
Deprecated.Gets the text of this titlevoid
send
(@NotNull Collection<? extends Player> players) Deprecated.Sends the title directly to the defined playersvoid
Deprecated.Sends the title directly to an playervoid
Deprecated.Sends the title directly to the defined players
-
Field Details
-
DEFAULT_FADE_IN
public static final int DEFAULT_FADE_INDeprecated.The default number of ticks for the title to fade in.- See Also:
-
DEFAULT_STAY
public static final int DEFAULT_STAYDeprecated.The default number of ticks for the title to stay.- See Also:
-
DEFAULT_FADE_OUT
public static final int DEFAULT_FADE_OUTDeprecated.The default number of ticks for the title to fade out.- See Also:
-
-
Constructor Details
-
Title
Deprecated.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
Deprecated.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
Deprecated.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 @NotNull net.md_5.bungee.api.chat.BaseComponent title, @Nullable @Nullable net.md_5.bungee.api.chat.BaseComponent subtitle) Deprecated.Create a title with the default time values.Times use default values.
- Parameters:
title
- the main text of the titlesubtitle
- the secondary text of the title
-
Title
public Title(@NotNull @NotNull net.md_5.bungee.api.chat.BaseComponent[] title, @Nullable @Nullable net.md_5.bungee.api.chat.BaseComponent[] subtitle) Deprecated.Create a title with the default time values.Times use default values.
- Parameters:
title
- the main text of the titlesubtitle
- the secondary text of the title
-
Title
Deprecated.Create a title with the default time values.Times use default values.
- Parameters:
title
- the main text of the titlesubtitle
- the secondary text of the title
-
Title
public Title(@NotNull @NotNull net.md_5.bungee.api.chat.BaseComponent title, @Nullable @Nullable net.md_5.bungee.api.chat.BaseComponent subtitle, int fadeIn, int stay, int fadeOut) Deprecated.Creates a new title.- Parameters:
title
- the main text of the titlesubtitle
- the secondary text of the titlefadeIn
- the number of ticks for the title to fade instay
- the number of ticks for the title to stay on screenfadeOut
- the number of ticks for the title to fade out- Throws:
IllegalArgumentException
- if any of the times are negative
-
Title
public Title(@Nullable @Nullable net.md_5.bungee.api.chat.BaseComponent[] title, @NotNull @NotNull net.md_5.bungee.api.chat.BaseComponent[] subtitle, int fadeIn, int stay, int fadeOut) Deprecated.Creates a new title.- Parameters:
title
- the main text of the titlesubtitle
- the secondary text of the titlefadeIn
- the number of ticks for the title to fade instay
- the number of ticks for the title to stay on screenfadeOut
- the number of ticks for the title to fade out- Throws:
IllegalArgumentException
- if any of the times are negative
-
Title
public Title(@NotNull @NotNull String title, @Nullable @Nullable String subtitle, int fadeIn, int stay, int fadeOut) Deprecated.Creates a new title.It is recommended to the
BaseComponent
constrctors.- Parameters:
title
- the main text of the titlesubtitle
- the secondary text of the titlefadeIn
- the number of ticks for the title to fade instay
- the number of ticks for the title to stay on screenfadeOut
- the number of ticks for the title to fade out
-
-
Method Details
-
getTitle
Deprecated.Gets the text of this title- Returns:
- the text
-
getSubtitle
Deprecated.Gets the text of this title's subtitle- Returns:
- the text
-
getFadeIn
public int getFadeIn()Deprecated.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()Deprecated.Gets the number of ticks to stay.The returned value is never negative.
- Returns:
- the number of ticks to stay
-
getFadeOut
public int getFadeOut()Deprecated.Gets the number of ticks to fade out.The returned value is never negative.
- Returns:
- the number of ticks to fade out
-
send
Deprecated.Sends the title directly to an player- Parameters:
player
- the receiver of the title
-
send
Deprecated.Sends the title directly to the defined players- Parameters:
players
- the receivers of the title
-
send
Deprecated.Sends the title directly to the defined players- Parameters:
players
- the receivers of the title
-
broadcast
public void broadcast()Deprecated.Sends the title directly to all online players -
builder
Deprecated.
-
Title