Package net.minestom.server.scoreboard

Class TabList

java.lang.Object

net.minestom.server.scoreboard.TabList

All Implemented Interfaces:

Audience, ForwardingAudience, Pointered, PacketGroupingAudience, Scoreboard, Viewable

public class TabList
extends Object
implements Scoreboard

Represents the Player tab list as a Scoreboard.

Nested Class Summary

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

ForwardingAudience.Single

Constructor Summary

Constructors

Constructor	Description
TabList(String name, ScoreboardObjectivePacket.Type type)

Method Summary

Modifier and Type	Method	Description
boolean	addViewer(@NotNull Player player)	Adds a viewer.
String	getObjectiveName()	Gets the objective name of the scoreboard.
ScoreboardObjectivePacket.Type	getType()	Gets the scoreboard objective type
@NotNull Set<Player>	getViewers()	Gets all the viewers of this viewable element.
boolean	removeViewer(@NotNull Player player)	Removes a viewer.
void	setType(ScoreboardObjectivePacket.Type type)	Changes the scoreboard objective type

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, deleteMessage, filterAudience, forEachAudience, openBook, playSound, pointers, 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.scoreboard.Scoreboard

getCreationObjectivePacket, getDestructionObjectivePacket, getDisplayScoreboardPacket, getPlayers, updateScore

Methods inherited from interface net.minestom.server.Viewable

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

Constructor Details

TabList

public TabList(String name,
 ScoreboardObjectivePacket.Type type)

Method Details

getType

public ScoreboardObjectivePacket.Type getType()

Gets the scoreboard objective type

Returns:

the scoreboard objective type

setType

public void setType(ScoreboardObjectivePacket.Type type)

Changes the scoreboard objective type

Parameters:

type - The new type for the objective

addViewer

public boolean addViewer(@NotNull
 @NotNull 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(@NotNull
 @NotNull 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

@NotNull
public @NotNull 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