Module net.minestom.server

Package net.minestom.server.scoreboard

Class Sidebar

java.lang.Object

net.minestom.server.scoreboard.Sidebar

All Implemented Interfaces:

Audience, ForwardingAudience, Pointered, PacketGroupingAudience, Scoreboard, Viewable

public class Sidebar
extends Object
implements Scoreboard

Represents a sidebar which can contain up to 16 Sidebar.ScoreboardLine.

In order to use it you need to create a new instance using the constructor Sidebar(String) and create new lines with createLine(ScoreboardLine). You can then add a Player to the viewing list using addViewer(Player) and remove him later with removeViewer(Player).

Lines can be modified using their respective identifier using updateLineContent(String, Component) and updateLineScore(String, int).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Sidebar.NumberFormat
static class	Sidebar.ScoreboardLine	This class is used to create a line for the sidebar.

Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience

ForwardingAudience.Single

Constructor Summary

Constructors

Constructor	Description
Sidebar(String title)	Deprecated. Use Sidebar(Component)
Sidebar(Component title)	Creates a new sidebar

Method Summary

Modifier and Type	Method	Description
boolean	addViewer(Player player)	Adds a viewer.
void	createLine(Sidebar.ScoreboardLine scoreboardLine)	Creates a new Sidebar.ScoreboardLine.
@Nullable Sidebar.ScoreboardLine	getLine(String id)	Gets a Sidebar.ScoreboardLine through the given identifier
Set<Sidebar.ScoreboardLine>	getLines()	Gets a Set containing all the registered lines.
String	getObjectiveName()	Gets the objective name of the scoreboard.
Set<Player>	getViewers()	Gets all the viewers of this viewable element.
void	removeLine(String id)	Removes a Sidebar.ScoreboardLine through the given identifier
boolean	removeViewer(Player player)	Removes a viewer.
void	setTitle(String title)	Deprecated. Use setTitle(Component)
void	setTitle(Component title)	Changes the Sidebar title
void	updateLineContent(String id, Component content)	Updates a Sidebar.ScoreboardLine content through the given identifier.
void	updateLineNumberFormat(String id, Sidebar.NumberFormat numberFormat)	Updates a Sidebar.ScoreboardLine number format through the given identifier.
void	updateLineScore(String id, int score)	Updates the score of a Sidebar.ScoreboardLine through the given identifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.adventure.audience.Audience

deleteMessage, openBook, removeResourcePacks, removeResourcePacks, removeResourcePacks, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, showTitle, stopSound

Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience

clearResourcePacks, closeDialog, deleteMessage, filterAudience, forEachAudience, openBook, playSound, pointers, removeResourcePacks, removeResourcePacks, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendResourcePacks, showDialog

Methods inherited from interface net.minestom.server.adventure.audience.PacketGroupingAudience

audiences, clearTitle, hideBossBar, playSound, playSound, playSound, resetTitle, sendActionBar, sendGroupedPacket, sendMessage, sendNotification, sendPlayerListHeaderAndFooter, sendTitlePart, showBossBar, stopSound

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom

Methods inherited from interface net.minestom.server.scoreboard.Scoreboard

getCreationObjectivePacket, getCreationObjectivePacket, getDestructionObjectivePacket, getDisplayScoreboardPacket, getPlayers, updateScore

Methods inherited from interface net.minestom.server.Viewable

getViewersAsAudience, getViewersAsAudiences, isViewer, sendPacketsToViewers, sendPacketsToViewers, sendPacketToViewers, sendPacketToViewersAndSelf

Constructor Details

Sidebar

@Deprecated
public Sidebar(String title)

Deprecated.

Use Sidebar(Component)

Creates a new sidebar

Parameters:

title - The title of the sidebar

Sidebar

public Sidebar(Component title)

Creates a new sidebar

Parameters:

title - The title of the sidebar

Method Details

setTitle

@Deprecated
public void setTitle(String title)

Deprecated.

Use setTitle(Component)

Changes the Sidebar title

Parameters:

title - The new sidebar title

setTitle

public void setTitle(Component title)

Changes the Sidebar title

Parameters:

title - The new sidebar title

createLine

public void createLine(Sidebar.ScoreboardLine scoreboardLine)

Creates a new Sidebar.ScoreboardLine.

Parameters:

scoreboardLine - the new scoreboard line

Throws:

IllegalStateException - if the sidebar cannot take more line

IllegalArgumentException - if the sidebar already contains the line scoreboardLine or has a line with the same id

updateLineContent

public void updateLineContent(String id,
 Component content)

Updates a Sidebar.ScoreboardLine content through the given identifier.

Parameters:

id - The identifier of the Sidebar.ScoreboardLine

content - The new content for the Sidebar.ScoreboardLine

updateLineScore

public void updateLineScore(String id,
 int score)

Updates the score of a Sidebar.ScoreboardLine through the given identifier

Parameters:

id - The identifier of the team

score - The new score for the Sidebar.ScoreboardLine

updateLineNumberFormat

public void updateLineNumberFormat(String id,
 Sidebar.NumberFormat numberFormat)

Updates a Sidebar.ScoreboardLine number format through the given identifier.

Parameters:

id - The identifier of the Sidebar.ScoreboardLine

numberFormat - The new number format for the Sidebar.ScoreboardLine

getLine

@Nullable
public @Nullable Sidebar.ScoreboardLine getLine(String id)

Gets a Sidebar.ScoreboardLine through the given identifier

Parameters:

id - The identifier of the line

Returns:

a Sidebar.ScoreboardLine or null

getLines

public Set<Sidebar.ScoreboardLine> getLines()

Gets a Set containing all the registered lines.

Returns:

an unmodifiable set containing the sidebar's lines

removeLine

public void removeLine(String id)

Removes a Sidebar.ScoreboardLine through the given identifier

Parameters:

id - the identifier of the Sidebar.ScoreboardLine

addViewer

public boolean addViewer(Player player)

Description copied from interface: Viewable

Adds a viewer.

Specified by:

addViewer in interface Viewable

Parameters:

player - the viewer to add

Returns:

true if the player has been added, false otherwise (could be because he is already a viewer)

removeViewer

public boolean removeViewer(Player player)

Description copied from interface: Viewable

Removes a viewer.

Specified by:

removeViewer in interface Viewable

Parameters:

player - the viewer to remove

Returns:

true if the player has been removed, false otherwise (could be because he was not a viewer)

getViewers

public Set<Player> getViewers()

Description copied from interface: Viewable

Gets all the viewers of this viewable element.

Specified by:

getViewers in interface Viewable

Returns:

A Set containing all the element's viewers

getObjectiveName

public String getObjectiveName()

Description copied from interface: Scoreboard

Gets the objective name of the scoreboard.

Specified by:

getObjectiveName in interface Scoreboard

Returns:

the objective name