net.glowstone.net.message.play.game

Class TitleMessage

java.lang.Object

net.glowstone.net.message.play.game.TitleMessage

All Implemented Interfaces:

com.flowpowered.network.Message

public final class TitleMessage
extends Object
implements com.flowpowered.network.Message

Documented at http://wiki.vg/Protocol#Title

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TitleMessage.Action

Constructor Summary

Constructors

Constructor and Description
TitleMessage(TitleMessage.Action action) Creates an instance with no message or times.
TitleMessage(TitleMessage.Action action, int fadeIn, int stay, int fadeOut) Creates an instance with times.
TitleMessage(TitleMessage.Action action, TextMessage text) Creates an instance with a message.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static TitleMessage[]	fromTitle(com.destroystokyo.paper.Title title) Converts a Title to 3 instances of TitleMessage.
TitleMessage.Action	getAction()
int	getFadeIn()
int	getFadeOut()
int	getStay()
TextMessage	getText()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TitleMessage

public TitleMessage(TitleMessage.Action action,
                    TextMessage text)

Creates an instance with a message.

Parameters:

action - should be TitleMessage.Action.TITLE, TitleMessage.Action.SUBTITLE or TitleMessage.Action.ACTION

text - the new text

TitleMessage

public TitleMessage(TitleMessage.Action action,
                    int fadeIn,
                    int stay,
                    int fadeOut)

Creates an instance with times.

Parameters:

action - should be TitleMessage.Action.TIMES

fadeIn - the fade-in duration in ticks

stay - the delay between the end of fade-in and the start of fade-out, in ticks

fadeOut - the fade-out duration in ticks

TitleMessage

public TitleMessage(TitleMessage.Action action)

Creates an instance with no message or times.

Parameters:

action - should be TitleMessage.Action.CLEAR or TitleMessage.Action.RESET

Method Detail

fromTitle

public static TitleMessage[] fromTitle(com.destroystokyo.paper.Title title)

Converts a Title to 3 instances of TitleMessage.

Parameters:

title - the title to convert

Returns:

3 messages: the first sets the title, the second sets the subtitle, and the third sets the fade/stay/fade durations

getAction

public TitleMessage.Action getAction()

getText

public TextMessage getText()

getFadeIn

public int getFadeIn()

getStay

public int getStay()

getFadeOut

public int getFadeOut()

equals

public boolean equals(Object o)

Specified by:

equals in interface com.flowpowered.network.Message

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface com.flowpowered.network.Message

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface com.flowpowered.network.Message

Overrides:

toString in class Object