com.velocitypowered.api.util.title

Class Titles

java.lang.Object

com.velocitypowered.api.util.title.Titles

public final class Titles
extends Object

Provides special-purpose titles.

Method Summary

Modifier and Type	Method and Description
static Title	hide() Returns a title that, when sent to the client, will cause any existing title to be hidden.
static Title	reset() Returns a title that, when sent to the client, will cause all title data to be reset and any existing title to be hidden.
static TextTitle.Builder	text() Returns a builder for TextTitles.

Methods inherited from class java.lang.Object

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

Method Detail

reset

public static Title reset()

Returns a title that, when sent to the client, will cause all title data to be reset and any existing title to be hidden.

Returns:

the reset title

hide

public static Title hide()

Returns a title that, when sent to the client, will cause any existing title to be hidden. The title may be restored by a TextTitle with no title or subtitle (only a time).

Returns:

the hide title

text

public static TextTitle.Builder text()

Returns a builder for TextTitles.

Returns:

a builder for text titles