Package com.velocitypowered.api.util

Enum Class MessagePosition

java.lang.Object

java.lang.Enum<MessagePosition>

com.velocitypowered.api.util.MessagePosition

All Implemented Interfaces:

Serializable, Comparable<MessagePosition>, Constable

public enum MessagePosition
extends Enum<MessagePosition>

Represents where a chat message is going to be sent.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTION_BAR	The chat message will appear above the player's main HUD.
CHAT	The chat message will appear in the client's HUD.
SYSTEM	The chat message will appear in the client's HUD and can't be dismissed.

Method Summary

Modifier and Type	Method	Description
static MessagePosition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessagePosition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CHAT

public static final MessagePosition CHAT

The chat message will appear in the client's HUD. These messages can be filtered out by the client.

SYSTEM

public static final MessagePosition SYSTEM

The chat message will appear in the client's HUD and can't be dismissed.

ACTION_BAR

public static final MessagePosition ACTION_BAR

The chat message will appear above the player's main HUD. This text format doesn't support many component features, such as hover events.

Method Details

values

public static MessagePosition[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MessagePosition valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null