com.bgsoftware.superiorskyblock.api.service.message

Enum IMessageComponent.Type

java.lang.Object

java.lang.Enum<IMessageComponent.Type>

com.bgsoftware.superiorskyblock.api.service.message.IMessageComponent.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IMessageComponent.Type>

Enclosing interface:

IMessageComponent

public static enum IMessageComponent.Type
extends java.lang.Enum<IMessageComponent.Type>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION_BAR The component represents an action bar.
BOSS_BAR The component represents a boss bar.
COMPLEX_MESSAGE The component represents a complex message.
EMPTY The component represents an empty message.
MULTIPLE The component represents multiple components.
RAW_MESSAGE The component represents a raw text message.
SOUND The component represents a sound.
TITLE The component represents a title.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTION_BAR

public static final IMessageComponent.Type ACTION_BAR

The component represents an action bar.

BOSS_BAR

public static final IMessageComponent.Type BOSS_BAR

The component represents a boss bar.

COMPLEX_MESSAGE

public static final IMessageComponent.Type COMPLEX_MESSAGE

The component represents a complex message. Complex messages are raw text that can be sent to players, however they have extra functionalities, such as clickable messages, hover messages, etc.

EMPTY

public static final IMessageComponent.Type EMPTY

The component represents an empty message. This type of component is used when the message of the component is empty or invalid.

MULTIPLE

public static final IMessageComponent.Type MULTIPLE

The component represents multiple components. This type of component is a container for different other components inside it. This gives the ability to combine different component types for the same message - for example, sending a message while playing a sound. Therefore, by calling IMessageComponent.sendMessage(CommandSender, Object...) on it, all the components it contains will be sent at the same time.

RAW_MESSAGE

public static final IMessageComponent.Type RAW_MESSAGE

The component represents a raw text message.

SOUND

public static final IMessageComponent.Type SOUND

The component represents a sound. When sending this component, a sound will be played instead of a message to be sent.

TITLE

public static final IMessageComponent.Type TITLE

The component represents a title. Titles are the big text that can be shown in the middle of the screen of a player.

Method Detail

values

public static IMessageComponent.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IMessageComponent.Type c : IMessageComponent.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static IMessageComponent.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null