Title (SpongeAPI 7.3.0 API)

java.lang.Object
- org.spongepowered.api.text.title.Title

```
public final class Title
extends Object
```
Represents an immutable configuration for an in-game title. Instances of this interface can be created through the Title.Builder by calling builder().
All properties of a title are optional - if they are not set it will use the current default values from the client.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Title.Builder
Represents a builder class to create immutable Title configurations.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Title.Builder` Represents a builder class to create immutable `Title` configurations.

Field Summary

Fields
Modifier and Type Field and Description

static Title CLEAR

static Title EMPTY

static Title RESET

Fields
Modifier and Type	Field and Description
`static Title`	`CLEAR`
`static Title`	`EMPTY`
`static Title`	`RESET`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Title.Builder`	`builder()` Creates a new `Title` configuration builder that will reset the currently displayed Title on the client before displaying the new configured one.
`static Title`	`clear()` Returns a `Title` that will clear the currently displayed `Title` from the player's screen.
`boolean`	`equals(Object o)`
`Optional<Text>`	`getActionBar()` Returns the action bar text of this title configuration.
`Optional<Integer>`	`getFadeIn()` Returns the specified time to fade in the title on the client.
`Optional<Integer>`	`getFadeOut()` Returns the specified time to fade out the title on the client.
`Optional<Integer>`	`getStay()` Returns the specified time how long the title should stay on the client.
`Optional<Text>`	`getSubtitle()` Returns the subtitle of this title configuration.
`Optional<Text>`	`getTitle()` Returns the title of this title configuration.
`int`	`hashCode()`
`boolean`	`isClear()` Returns whether this configuration is clearing the current title from the screen.
`boolean`	`isReset()` Returns whether this configuration is clearing the current title from the screen and resetting the current configuration to the default values.
`static Title`	`of()` Returns a `Title` that will simply do nothing when it is sent to the client.
`static Title`	`of(Text title)` Returns a `Title` that will display the given main title on the player's screen.
`static Title`	`of(Text title, Text subtitle)` Returns a `Title` that will display the given main and subtitle on the player's screen.
`static Title`	`reset()` Returns a `Title` that will reset the current title back to default values on the client.
`Title.Builder`	`toBuilder()` Creates a new `Title.Builder` using the configuration of this instance.
`String`	`toString()`
`static Title.Builder`	`update()` Creates a new empty `Title` configuration builder.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final Title EMPTY
```
  - CLEAR
```
public static final Title CLEAR
```
  - RESET
```
public static final Title RESET
```
- Method Detail
  - getTitle
```
public Optional<Text> getTitle()
```
    Returns the title of this title configuration.
    
    Returns:
    
    The Text of the title, if it was configured
  - getSubtitle
```
public Optional<Text> getSubtitle()
```
    Returns the subtitle of this title configuration.
    
    Returns:
    
    The Text of the subtitle, if it was configured
  - getActionBar
```
public Optional<Text> getActionBar()
```
    Returns the action bar text of this title configuration.
    
    Returns:
    
    The Text of the action bar, if it was configured
  - getFadeIn
```
public Optional<Integer> getFadeIn()
```
    Returns the specified time to fade in the title on the client. Once this period of time is over, the title will stay for the amount of time from getStay().
    The default value for Vanilla is 20 (1 second).
    
    Returns:
    
    The amount of ticks (1/20 second) for the fade in effect
  - getStay
```
public Optional<Integer> getStay()
```
    Returns the specified time how long the title should stay on the client. Once this period of time is over, the title will fade out using the duration specified from getFadeOut().
    The default value for Vanilla is 60 (3 second).
    
    Returns:
    
    The amount of ticks (1/20 second) for the stay effect
  - getFadeOut
```
public Optional<Integer> getFadeOut()
```
    Returns the specified time to fade out the title on the client.
    The default value for Vanilla is 20 (1 second).
    
    Returns:
    
    The amount of ticks (1/20 second) for the fade out effect
  - isClear
```
public boolean isClear()
```
    Returns whether this configuration is clearing the current title from the screen.
    
    Returns:
    
    True if the current title will be removed from the client's screen
  - isReset
```
public boolean isReset()
```
    Returns whether this configuration is clearing the current title from the screen and resetting the current configuration to the default values.
    This is recommended when you want to make sure to display a single title.
    
    Returns:
    
    True if the current settings will be reset to the defaults
  - toBuilder
```
public Title.Builder toBuilder()
```
    Creates a new Title.Builder using the configuration of this instance.
    
    Returns:
    
    A new builder to modify this Title configuration
  - equals
```
public boolean equals(@Nullable
                      Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static Title of()
```
    Returns a Title that will simply do nothing when it is sent to the client.
    
    Returns:
    
    An empty title instance
  - of
```
public static Title of(Text title)
```
    Returns a Title that will display the given main title on the player's screen.
    
    Parameters:
    
    title - The title to display
    
    Returns:
    
    The created title
  - of
```
public static Title of(Text title,
                       Text subtitle)
```
    Returns a Title that will display the given main and subtitle on the player's screen.
    
    Parameters:
    
    title - The title to display
    
    subtitle - The subtitle to display
    
    Returns:
    
    The created title
  - clear
```
public static Title clear()
```
    Returns a Title that will clear the currently displayed Title from the player's screen.
    
    Returns:
    
    A title configuration that will clear
  - reset
```
public static Title reset()
```
    Returns a Title that will reset the current title back to default values on the client.
    
    Returns:
    
    A title configuration that will reset
  - builder
```
public static Title.Builder builder()
```
    Creates a new Title configuration builder that will reset the currently displayed Title on the client before displaying the new configured one.
    
    Returns:
    
    A new Title.Builder
    
    See Also:
    
    update()
  - update
```
public static Title.Builder update()
```
    Creates a new empty Title configuration builder. Unlike builder() this won't reset the current Title on the client before displaying the current one. This has less use cases but should be used if just the previously sent Title should be updated.
    
    Returns:
    
    A new Title.Builder
    
    See Also:
    
    builder()

Class Title

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

CLEAR

RESET

Method Detail

getTitle

getSubtitle

getActionBar

getFadeIn

getStay

getFadeOut

isClear

isReset

toBuilder

equals

hashCode

toString

of

of

of

clear

reset

builder

update