Package net.minestom.server.scoreboard

Class BelowNameTag

java.lang.Object

net.minestom.server.scoreboard.BelowNameTag

All Implemented Interfaces:

Audience, ForwardingAudience, Pointered, PacketGroupingAudience, Scoreboard, Viewable

public class BelowNameTag
extends Object
implements Scoreboard

Represents a scoreboard which rendered a tag below the name.

Nested Class Summary

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

ForwardingAudience.Single

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BELOW_NAME_TAG_PREFIX	WARNING: You shouldn't create scoreboards with the same prefix as those

Constructor Summary

Constructors

Constructor	Description
BelowNameTag(String name, String value)	Deprecated. Use BelowNameTag(String, Component)
BelowNameTag(String name, Component value)	Creates a new below name scoreboard.

Method Summary

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

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, getCreationObjectivePacket, getDestructionObjectivePacket, getDisplayScoreboardPacket, getPlayers, updateScore

Methods inherited from interface net.minestom.server.Viewable

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

Field Details

BELOW_NAME_TAG_PREFIX

public static final String BELOW_NAME_TAG_PREFIX

WARNING: You shouldn't create scoreboards with the same prefix as those

See Also:

• Constant Field Values

Constructor Details

BelowNameTag

@Deprecated
public BelowNameTag(String name,
 String value)

Deprecated.

Use BelowNameTag(String, Component)

Creates a new below name scoreboard.

Parameters:

name - The objective name of the scoreboard

value - The value of the scoreboard

BelowNameTag

public BelowNameTag(String name,
 Component value)

Creates a new below name scoreboard.

Parameters:

name - The objective name of the scoreboard

value - The value of the scoreboard

Method Details

getObjectiveName

@NotNull
public @NotNull String getObjectiveName()

Description copied from interface: Scoreboard

Gets the objective name of the scoreboard.

Specified by:

getObjectiveName in interface Scoreboard

Returns:

the objective name

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