Package dev.jorel.commandapi.wrappers

Enum Class ScoreboardSlot

java.lang.Object

java.lang.Enum<ScoreboardSlot>

dev.jorel.commandapi.wrappers.ScoreboardSlot

All Implemented Interfaces:

Serializable, Comparable<ScoreboardSlot>, Constable, net.kyori.adventure.key.Keyed, org.bukkit.Keyed

public enum ScoreboardSlot
extends Enum<ScoreboardSlot>
implements org.bukkit.Keyed

A representation of scoreboard display slots, as well as team colors for the sidebar

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
BELOW_NAME
LEGACY_BELOW_NAME
PLAYER_LIST
SIDEBAR
SIDEBAR_TEAM_AQUA
SIDEBAR_TEAM_BLACK
SIDEBAR_TEAM_BLUE
SIDEBAR_TEAM_DARK_AQUA
SIDEBAR_TEAM_DARK_BLUE
SIDEBAR_TEAM_DARK_GRAY
SIDEBAR_TEAM_DARK_GREEN
SIDEBAR_TEAM_DARK_PURPLE
SIDEBAR_TEAM_DARK_RED
SIDEBAR_TEAM_GOLD
SIDEBAR_TEAM_GRAY
SIDEBAR_TEAM_GREEN
SIDEBAR_TEAM_LIGHT_PURPLE
SIDEBAR_TEAM_RED
SIDEBAR_TEAM_WHITE
SIDEBAR_TEAM_YELLOW

Method Summary

Modifier and Type	Method	Description
org.bukkit.scoreboard.DisplaySlot	getDisplaySlot()	Gets the display slot of this scoreboard slot.
org.bukkit.NamespacedKey	getKey()
org.bukkit.ChatColor	getTeamColor()	Gets the team color of this scoreboard slot.
boolean	hasTeamColor()	Returns whether this scoreboard slot has a team color.
static ScoreboardSlot	of(org.bukkit.scoreboard.DisplaySlot slot)	Constructs a ScoreboardSlot from a DisplaySlot
static ScoreboardSlot	ofMinecraft(int i)	Determines the scoreboard slot value based on an internal Minecraft integer
static ScoreboardSlot	ofTeamColor(org.bukkit.ChatColor color)	Constructs a ScoreboardSlot from a ChatColor
String	toString()	Returns the Minecraft string representation of this scoreboard slot
static ScoreboardSlot	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScoreboardSlot[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bukkit.Keyed

key

Enum Constant Details

PLAYER_LIST

public static final ScoreboardSlot PLAYER_LIST

SIDEBAR

public static final ScoreboardSlot SIDEBAR

LEGACY_BELOW_NAME

public static final ScoreboardSlot LEGACY_BELOW_NAME

BELOW_NAME

public static final ScoreboardSlot BELOW_NAME

SIDEBAR_TEAM_BLACK

public static final ScoreboardSlot SIDEBAR_TEAM_BLACK

SIDEBAR_TEAM_DARK_BLUE

public static final ScoreboardSlot SIDEBAR_TEAM_DARK_BLUE

SIDEBAR_TEAM_DARK_GREEN

public static final ScoreboardSlot SIDEBAR_TEAM_DARK_GREEN

SIDEBAR_TEAM_DARK_AQUA

public static final ScoreboardSlot SIDEBAR_TEAM_DARK_AQUA

SIDEBAR_TEAM_DARK_RED

public static final ScoreboardSlot SIDEBAR_TEAM_DARK_RED

SIDEBAR_TEAM_DARK_PURPLE

public static final ScoreboardSlot SIDEBAR_TEAM_DARK_PURPLE

SIDEBAR_TEAM_GOLD

public static final ScoreboardSlot SIDEBAR_TEAM_GOLD

SIDEBAR_TEAM_GRAY

public static final ScoreboardSlot SIDEBAR_TEAM_GRAY

SIDEBAR_TEAM_DARK_GRAY

public static final ScoreboardSlot SIDEBAR_TEAM_DARK_GRAY

SIDEBAR_TEAM_BLUE

public static final ScoreboardSlot SIDEBAR_TEAM_BLUE

SIDEBAR_TEAM_GREEN

public static final ScoreboardSlot SIDEBAR_TEAM_GREEN

SIDEBAR_TEAM_AQUA

public static final ScoreboardSlot SIDEBAR_TEAM_AQUA

SIDEBAR_TEAM_RED

public static final ScoreboardSlot SIDEBAR_TEAM_RED

SIDEBAR_TEAM_LIGHT_PURPLE

public static final ScoreboardSlot SIDEBAR_TEAM_LIGHT_PURPLE

SIDEBAR_TEAM_YELLOW

public static final ScoreboardSlot SIDEBAR_TEAM_YELLOW

SIDEBAR_TEAM_WHITE

public static final ScoreboardSlot SIDEBAR_TEAM_WHITE

Method Details

values

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

ofMinecraft

public static ScoreboardSlot ofMinecraft(int i)

Determines the scoreboard slot value based on an internal Minecraft integer

Parameters:

i - the scoreboard slot value

of

public static ScoreboardSlot of(org.bukkit.scoreboard.DisplaySlot slot)

Constructs a ScoreboardSlot from a DisplaySlot

Parameters:

slot - the display slot to convert into a ScoreboardSlot

Returns:

a ScoreboardSlot from the provided DisplaySlot

ofTeamColor

public static ScoreboardSlot ofTeamColor(org.bukkit.ChatColor color)

Constructs a ScoreboardSlot from a ChatColor

Parameters:

color - the chat color to convert into a ScoreboardSlot

Returns:

a ScoreboardSlot from the provided ChatColor

getDisplaySlot

public org.bukkit.scoreboard.DisplaySlot getDisplaySlot()

Gets the display slot of this scoreboard slot.

Returns:

this scoreboard slot's display slot

getTeamColor

public org.bukkit.ChatColor getTeamColor()

Gets the team color of this scoreboard slot.

Returns:

this scoreboard slot's team color, or null if a team color is not present

hasTeamColor

public boolean hasTeamColor()

Returns whether this scoreboard slot has a team color.

Returns:

true if this scoreboard slot has a team color

getKey

public org.bukkit.NamespacedKey getKey()

Specified by:

getKey in interface org.bukkit.Keyed

toString

public String toString()

Returns the Minecraft string representation of this scoreboard slot

Overrides:

toString in class Enum<ScoreboardSlot>

Returns:

the Minecraft string representation of this scoreboard slot