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

Class Scoreboard

java.lang.Object

me.remigio07.chatplugin.api.server.scoreboard.Scoreboard

public abstract class Scoreboard
extends Object

Represents a scoreboard handled by the ScoreboardManager.

See Also:

• ChatPlugin wiki/Modules/Scoreboards

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Scoreboard.Builder	Represents the builder used to create Scoreboards using ScoreboardManager.createScoreboardBuilder(String, boolean, List).

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	SCORES	Represents the scores' names used by the scoreboard.

Constructor Summary

Constructors

Constructor	Description
Scoreboard()

Method Summary

Modifier and Type	Method	Description
abstract void	addPlayer(ChatPluginServerPlayer player)	Adds a player to getPlayers().
Configuration	getConfiguration()	Gets the configuration associated with this scoreboard.
String	getID()	Gets this scoreboard's ID.
ScoreboardLines	getLines()	Gets this scoreboard's lines.
ScoreboardNumbers	getNumbers()	Gets this scoreboard's numbers.
List<PlaceholderType>	getPlaceholderTypes()	Gets the list of placeholder types used to translate getTitles() and getLines().
List<ChatPluginServerPlayer>	getPlayers()	Gets the list of players this scoreboard is being displayed to.
ScoreboardTitles	getTitles()	Gets this scoreboard's titles.
ScoreboardType	getType()	Gets this scoreboard's type.
abstract void	removePlayer(ChatPluginServerPlayer player)	Removes a player from getPlayers().
boolean	shouldAbbreviateLongText()	Checks if text (scoreboards' lines and titles) should be abbreviated by adding "..." at the end when it is too long to be displayed instead of ScoreboardTitles.TITLE_TOO_LONG or ScoreboardLines.LINE_TOO_LONG.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SCORES

public static final String[] SCORES

Represents the scores' names used by the scoreboard.

Constructor Details

Scoreboard

public Scoreboard()

Method Details

getID

public String getID()

Gets this scoreboard's ID.

Returns:

Scoreboard's ID

getType

public ScoreboardType getType()

Gets this scoreboard's type.

Returns:

Scoreboard's type

getConfiguration

public Configuration getConfiguration()

Gets the configuration associated with this scoreboard.

Will return null if this scoreboard was created using ScoreboardManager.createScoreboardBuilder(String, boolean, List).

Returns:

Associated configuration

getTitles

public ScoreboardTitles getTitles()

Gets this scoreboard's titles.

Returns:

Scoreboard's titles

getLines

public ScoreboardLines getLines()

Gets this scoreboard's lines.

Returns:

Scoreboard's lines

getNumbers

public ScoreboardNumbers getNumbers()

Gets this scoreboard's numbers.

Returns:

Scoreboard's numbers

shouldAbbreviateLongText

public boolean shouldAbbreviateLongText()

Checks if text (scoreboards' lines and titles) should be abbreviated by adding "..." at the end when it is too long to be displayed instead of ScoreboardTitles.TITLE_TOO_LONG or ScoreboardLines.LINE_TOO_LONG.

Found at: "settings.abbreviate-long-text" in getConfiguration()

Returns:

Whether to abbreviate long text

getPlaceholderTypes

public List<PlaceholderType> getPlaceholderTypes()

Gets the list of placeholder types used to translate getTitles() and getLines().

Found at: "settings.placeholder-types" in getConfiguration()

Returns:

Placeholders used to translate titles and lines

getPlayers

public List<ChatPluginServerPlayer> getPlayers()

Gets the list of players this scoreboard is being displayed to.

Do not modify the returned list. Use addPlayer(ChatPluginServerPlayer) and removePlayer(ChatPluginServerPlayer) to interact with it.

Returns:

Scoreboard's players

addPlayer

public abstract void addPlayer(ChatPluginServerPlayer player)

Adds a player to getPlayers().

Parameters:

player - Player to add

See Also:

• ScoreboardAddPlayerEvent

removePlayer

public abstract void removePlayer(ChatPluginServerPlayer player)

Removes a player from getPlayers().

Parameters:

player - Player to remove

See Also:

• ScoreboardRemovePlayerEvent