Enum Class MessagePipeline.ReplacementTag

java.lang.Object

java.lang.Enum<MessagePipeline.ReplacementTag>

net.flectone.pulse.pipeline.MessagePipeline.ReplacementTag

All Implemented Interfaces:

Serializable, Comparable<MessagePipeline.ReplacementTag>, Constable

Enclosing interface:

MessagePipeline

public static enum MessagePipeline.ReplacementTag
extends Enum<MessagePipeline.ReplacementTag>

Every tag the formatting modules can insert. The lowercase name is the tag written in a message.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFK
ANIMATION
CONDITION
CONSTANT
DELETE
DISPLAY_NAME
FADING
FCOLOR
MENTION
MUTE
NICKNAME
ONLINE
PADDING
PLAYER
PLAYER_HEAD
PLAYER_HEAD_OR
PREFIX
QUESTION
REPLACEMENT
SERVER
SPRITE
SPRITE_OR
STREAM
SUFFIX
SWEAR
TEXTURE
TEXTURE_OR
TOPONLINE
TRANSLATION
WORLD

Method Summary

Modifier and Type	Method	Description
static net.kyori.adventure.text.minimessage.tag.resolver.TagResolver	emptyResolver(String tag)	A resolver that erases a tag, used when the module behind it is switched off.
static @NonNull net.kyori.adventure.text.minimessage.tag.resolver.TagResolver	emptyResolver(@NonNull net.kyori.adventure.text.minimessage.tag.resolver.TagResolver tagResolver)	A resolver that erases every replacement tag the given resolver does not serve itself
static net.kyori.adventure.text.minimessage.tag.Tag	emptyTag()	A tag that renders to nothing.
String	getTagName()	The tag as written in a message.
static MessagePipeline.ReplacementTag	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessagePipeline.ReplacementTag[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AFK

public static final MessagePipeline.ReplacementTag AFK

ANIMATION

public static final MessagePipeline.ReplacementTag ANIMATION

CONDITION

public static final MessagePipeline.ReplacementTag CONDITION

MUTE

public static final MessagePipeline.ReplacementTag MUTE

STREAM

public static final MessagePipeline.ReplacementTag STREAM

SERVER

public static final MessagePipeline.ReplacementTag SERVER

SUFFIX

public static final MessagePipeline.ReplacementTag SUFFIX

PREFIX

public static final MessagePipeline.ReplacementTag PREFIX

DELETE

public static final MessagePipeline.ReplacementTag DELETE

DISPLAY_NAME

public static final MessagePipeline.ReplacementTag DISPLAY_NAME

PLAYER

public static final MessagePipeline.ReplacementTag PLAYER

NICKNAME

public static final MessagePipeline.ReplacementTag NICKNAME

CONSTANT

public static final MessagePipeline.ReplacementTag CONSTANT

REPLACEMENT

public static final MessagePipeline.ReplacementTag REPLACEMENT

MENTION

public static final MessagePipeline.ReplacementTag MENTION

TOPONLINE

public static final MessagePipeline.ReplacementTag TOPONLINE

ONLINE

public static final MessagePipeline.ReplacementTag ONLINE

PADDING

public static final MessagePipeline.ReplacementTag PADDING

SWEAR

public static final MessagePipeline.ReplacementTag SWEAR

QUESTION

public static final MessagePipeline.ReplacementTag QUESTION

TRANSLATION

public static final MessagePipeline.ReplacementTag TRANSLATION

WORLD

public static final MessagePipeline.ReplacementTag WORLD

PLAYER_HEAD

public static final MessagePipeline.ReplacementTag PLAYER_HEAD

PLAYER_HEAD_OR

public static final MessagePipeline.ReplacementTag PLAYER_HEAD_OR

SPRITE

public static final MessagePipeline.ReplacementTag SPRITE

SPRITE_OR

public static final MessagePipeline.ReplacementTag SPRITE_OR

TEXTURE

public static final MessagePipeline.ReplacementTag TEXTURE

TEXTURE_OR

public static final MessagePipeline.ReplacementTag TEXTURE_OR

FADING

public static final MessagePipeline.ReplacementTag FADING

FCOLOR

public static final MessagePipeline.ReplacementTag FCOLOR

Method Details

values

public static MessagePipeline.ReplacementTag[] 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 MessagePipeline.ReplacementTag 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

emptyResolver

public static net.kyori.adventure.text.minimessage.tag.resolver.TagResolver emptyResolver(@TagPattern
 String tag)

A resolver that erases a tag, used when the module behind it is switched off.

Parameters:

tag - the tag name

Returns:

the resolver

emptyResolver

public static @NonNull net.kyori.adventure.text.minimessage.tag.resolver.TagResolver emptyResolver(@NonNull net.kyori.adventure.text.minimessage.tag.resolver.TagResolver tagResolver)

A resolver that erases every replacement tag the given resolver does not serve itself

Parameters:

tagResolver - the resolvers already in scope

Returns:

the resolver

emptyTag

public static net.kyori.adventure.text.minimessage.tag.Tag emptyTag()

A tag that renders to nothing.

Returns:

the empty tag

getTagName

public String getTagName()

The tag as written in a message.

Returns:

the lowercase tag name