Package me.remigio07.chatplugin.api.server.scoreboard

Enum Class NumbersDisplayMode

java.lang.Object

java.lang.Enum<NumbersDisplayMode>

me.remigio07.chatplugin.api.server.scoreboard.NumbersDisplayMode

All Implemented Interfaces:

Serializable, Comparable<NumbersDisplayMode>, Constable

public enum NumbersDisplayMode
extends Enum<NumbersDisplayMode>

Represents the display mode of ScoreboardNumbers: default, only zeros and custom text.

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
CUSTOM_TEXT	Scores will use custom text which may contain formatting codes and be animated.
DEFAULT	Scores will use red numbers from 0 to 14 based on the number of lines.
ONLY_ZEROS	Scores will use red zeros for every line.

Method Summary

Modifier and Type	Method	Description
boolean	isSupported()	Checks if this numbers display mode is supported on VersionUtils.getVersion().
static NumbersDisplayMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NumbersDisplayMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final NumbersDisplayMode DEFAULT

Scores will use red numbers from 0 to 14 based on the number of lines.

This format is used for scoreboards sent to players connected through Bedrock.

ONLY_ZEROS

public static final NumbersDisplayMode ONLY_ZEROS

Scores will use red zeros for every line.

This format is used for scoreboards sent to players connected using 1.20.2 or lower when CUSTOM_TEXT is selected.

CUSTOM_TEXT

public static final NumbersDisplayMode CUSTOM_TEXT

Scores will use custom text which may contain formatting codes and be animated.

Minimum version: 1.20.3
Found at: "settings.numbers.custom-text" in Scoreboard.getConfiguration()

Method Details

values

public static NumbersDisplayMode[] 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 NumbersDisplayMode 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

isSupported

public boolean isSupported()

Checks if this numbers display mode is supported on VersionUtils.getVersion().

Returns:

Whether this display mode is supported