org.spongepowered.api.text.title

Class Title.Builder

java.lang.Object

org.spongepowered.api.text.title.Title.Builder

Enclosing class:

Title

public static final class Title.Builder
extends Object

Represents a builder class to create immutable Title configurations.

See Also:

Title

Method Summary

Modifier and Type	Method and Description
Title.Builder	actionBar(Text actionBar) Sets the action bar text to send to the player.
Title	build() Builds an immutable instance of the current configuration.
Title.Builder	clear() Removes the currently displayed title from the player's screen.
Title.Builder	clear(boolean clear) Sets whether the the currently displayed title should be removed from the player's screen and will keep the currently used display times.
boolean	equals(Object o)
Title.Builder	fadeIn(Integer fadeIn) Sets the duration in ticks of the fade in effect of the title.
Title.Builder	fadeOut(Integer fadeOut) Sets the duration in ticks of the fade out effect of the title.
Optional<Text>	getActionBar() Returns the current action bar text of this builder.
Optional<Integer>	getFadeIn() Returns the current fade in effect time of the title.
Optional<Integer>	getFadeOut() Returns the current fade out effect time of the title.
Optional<Integer>	getStay() Returns the current stay effect time of the title.
Optional<Text>	getSubtitle() Returns the current subtitle of this builder.
Optional<Text>	getTitle() Returns the current title of this builder.
int	hashCode()
boolean	isClear() Returns whether this builder is currently configured to clear.
boolean	isReset() Returns whether this builder is currently configured to reset.
Title.Builder	reset() Removes the currently displayed title from the player's screen and set the configuration back to the default values.
Title.Builder	reset(boolean reset) Sets whether the currently displayed title should be removed from the player's screen and the configuration set back to the default values.
Title.Builder	stay(Integer stay) Sets the duration in ticks how long the title should stay on the screen.
Title.Builder	subtitle(Text subtitle) Sets the subtitle to send to the player.
Title.Builder	title(Text title) Sets the title to send to the player.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getTitle

public Optional<Text> getTitle()

Returns the current title of this builder.

Returns:

The current main title, or Optional.empty() if none

See Also:

Title.getTitle()

title

public Title.Builder title(@Nullable
                           Text title)

Sets the title to send to the player.

Parameters:

title - The text to use as the title, or null to reset

Returns:

This title builder

See Also:

Title.getTitle()

getSubtitle

public Optional<Text> getSubtitle()

Returns the current subtitle of this builder.

Returns:

The current subtitle, or Optional.empty() if none

See Also:

Title.getSubtitle()

subtitle

public Title.Builder subtitle(@Nullable
                              Text subtitle)

Sets the subtitle to send to the player.

Parameters:

subtitle - The text to use as the subtitle, or null to reset

Returns:

This title builder

See Also:

Title.getSubtitle()

getActionBar

public Optional<Text> getActionBar()

Returns the current action bar text of this builder.

Returns:

The current action bar text, or Optional.empty() if none

See Also:

Title.getActionBar()

actionBar

public Title.Builder actionBar(@Nullable
                               Text actionBar)

Sets the action bar text to send to the player.

Parameters:

actionBar - The text to use for the action bar, or null to reset

Returns:

This title builder

See Also:

Title.getActionBar()

getFadeIn

public Optional<Integer> getFadeIn()

Returns the current fade in effect time of the title.

Returns:

The current fade in time, or Optional.empty() if none

See Also:

Title.getFadeIn()

fadeIn

public Title.Builder fadeIn(@Nullable
                            Integer fadeIn)

Sets the duration in ticks of the fade in effect of the title. Once this period of time is over the title will stay for the amount of time specified in stay(Integer).

The default value for Vanilla is 20 (1 second).

Parameters:

fadeIn - The amount of ticks (1/20 second) for the fade in effect, or null to reset

Returns:

This title builder

See Also:

Title.getFadeIn()

getStay

public Optional<Integer> getStay()

Returns the current stay effect time of the title.

Returns:

The current stay time, or Optional.empty() if none

See Also:

Title.getStay()

stay

public Title.Builder stay(@Nullable
                          Integer stay)

Sets the duration in ticks how long the title should stay on the screen. Once this period of time is over the title will fade out using the duration specified in fadeOut(Integer).

The default value for Vanilla is 60 (3 seconds).

Parameters:

stay - The amount of ticks (1/20 second) to stay, or null to reset

Returns:

This title builder

See Also:

Title.getStay()

getFadeOut

public Optional<Integer> getFadeOut()

Returns the current fade out effect time of the title.

Returns:

The current fade out time, or Optional.empty() if none

See Also:

Title.getFadeOut()

fadeOut

public Title.Builder fadeOut(@Nullable
                             Integer fadeOut)

Sets the duration in ticks of the fade out effect of the title.

The default value for Vanilla is 20 (1 second).

Parameters:

fadeOut - The amount of ticks (1/20 second) for the fade out effect, or null to reset

Returns:

This title builder

See Also:

Title.getFadeOut()

isClear

public boolean isClear()

Returns whether this builder is currently configured to clear.

Returns:

true if the title will clear

See Also:

Title.isClear()

clear

public Title.Builder clear()

Removes the currently displayed title from the player's screen. This will keep the currently used display times and will only remove the title.

Returns:

This title builder

See Also:

Title.isClear()

clear

public Title.Builder clear(boolean clear)

Sets whether the the currently displayed title should be removed from the player's screen and will keep the currently used display times.

Parameters:

clear - Whether this title should clear

Returns:

This title builder

See Also:

Title.isClear()

isReset

public boolean isReset()

Returns whether this builder is currently configured to reset.

Returns:

true if the title will reset

See Also:

Title.isReset()

reset

public Title.Builder reset()

Removes the currently displayed title from the player's screen and set the configuration back to the default values.

Returns:

This title builder

See Also:

Title.isReset()

reset

public Title.Builder reset(boolean reset)

Sets whether the currently displayed title should be removed from the player's screen and the configuration set back to the default values.

Parameters:

reset - Whether this title should reset

Returns:

This title builder

See Also:

Title.isReset()

build

public Title build()

Builds an immutable instance of the current configuration.

Returns:

An immutable Title with the currently configured settings

equals

public boolean equals(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