Package net.minestom.server.scoreboard

Interface Scoreboard

All Superinterfaces:

Audience, ForwardingAudience, PacketGroupingAudience, Pointered, Viewable

All Known Implementing Classes:

BelowNameTag, Sidebar, TabList

public interface Scoreboard
extends Viewable, PacketGroupingAudience

This interface represents all scoreboard of Minecraft.

Nested Class Summary

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

ForwardingAudience.Single

Method Summary

Modifier and Type	Method	Description
default @NotNull ScoreboardObjectivePacket	getCreationObjectivePacket(String value, ScoreboardObjectivePacket.Type type)	Deprecated. Use getCreationObjectivePacket(Component, ScoreboardObjectivePacket.Type)
default @NotNull ScoreboardObjectivePacket	getCreationObjectivePacket(Component value, ScoreboardObjectivePacket.Type type)	Creates a creation objective packet.
default @NotNull ScoreboardObjectivePacket	getDestructionObjectivePacket()	Creates the destruction objective packet.
default @NotNull DisplayScoreboardPacket	getDisplayScoreboardPacket(byte position)	Creates the DisplayScoreboardPacket.
@NotNull String	getObjectiveName()	Gets the objective name of the scoreboard.
default @NotNull Collection<Player>	getPlayers()	Gets an iterable of the players this audience contains.
default void	updateScore(Player player, int score)	Updates the score of a Player.

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, deleteMessage, filterAudience, forEachAudience, openBook, playSound, pointers, removeResourcePacks, removeResourcePacks, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendResourcePacks

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

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

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

get, getOrDefault, getOrDefaultFrom

Methods inherited from interface net.minestom.server.Viewable

addViewer, getViewers, getViewersAsAudience, getViewersAsAudiences, isViewer, removeViewer, sendPacketsToViewers, sendPacketsToViewers, sendPacketToViewers, sendPacketToViewersAndSelf

Method Details

getCreationObjectivePacket

@Deprecated
@NotNull
default @NotNull ScoreboardObjectivePacket getCreationObjectivePacket(String value,
 ScoreboardObjectivePacket.Type type)

Deprecated.

Use getCreationObjectivePacket(Component, ScoreboardObjectivePacket.Type)

Creates a creation objective packet.

Parameters:

value - The value for the objective

type - The type for the objective

Returns:

the creation objective packet

getCreationObjectivePacket

@NotNull
default @NotNull ScoreboardObjectivePacket getCreationObjectivePacket(Component value,
 ScoreboardObjectivePacket.Type type)

Creates a creation objective packet.

Parameters:

value - The value for the objective

type - The type for the objective

Returns:

the creation objective packet

getDestructionObjectivePacket

@NotNull
default @NotNull ScoreboardObjectivePacket getDestructionObjectivePacket()

Creates the destruction objective packet.

Returns:

the destruction objective packet

getDisplayScoreboardPacket

@NotNull
default @NotNull DisplayScoreboardPacket getDisplayScoreboardPacket(byte position)

Creates the DisplayScoreboardPacket.

Parameters:

position - The position of the scoreboard

Returns:

the created display scoreboard packet

updateScore

default void updateScore(Player player,
 int score)

Updates the score of a Player.

Parameters:

player - The player

score - The new score

getObjectiveName

@NotNull
@NotNull String getObjectiveName()

Gets the objective name of the scoreboard.

Returns:

the objective name

getPlayers

@NotNull
default @NotNull Collection<Player> getPlayers()

Description copied from interface: PacketGroupingAudience

Gets an iterable of the players this audience contains.

Specified by:

getPlayers in interface PacketGroupingAudience

Returns:

the connections