Module net.kyori.adventure.api

Package net.kyori.adventure.text

Interface ScoreComponent

All Superinterfaces:

Buildable<ScoreComponent.Builder>, BuildableComponent<ScoreComponent,ScoreComponent.Builder>, Component, ComponentBuilderApplicable, ComponentLike, HoverEventSource<Component>, ScopedComponent<ScoreComponent>, StyleGetter, StyleSetter<Component>

public sealed interface ScoreComponent
extends ScopedComponent<ScoreComponent>, BuildableComponent<ScoreComponent,ScoreComponent.Builder>

A component that can display a player's score from a scoreboard objective, with an optional fallback value if the search for the score fails.

This component consists of:

name

a player username or a Minecraft selector that leads to a single player

objective

a scoreboard objective

value (optional, obsolete)

a value to use that will override any queried scoreboard value

This field is no longer present in the game from 1.16.5, which means it will be ignored

This component is rendered serverside and can therefore receive platform-defined context. See the documentation for your respective platform for more info

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ScoreComponent.Builder	A score component builder.

Field Summary

Fields inherited from interface net.kyori.adventure.text.Component

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
String	name()	Gets the score name.
ScoreComponent	name(String name)	Sets the score name.
String	objective()	Gets the objective name.
ScoreComponent	objective(String objective)	Sets the score objective.
ScoreComponent.Builder	toBuilder()	Returns a builder for this component.
@Nullable String	value()	Gets the value.
ScoreComponent	value(String value)	Sets the value.

Methods inherited from interface net.kyori.adventure.text.Component

asHoverEvent, children, clickEvent, color, compact, compact, componentBuilderApply, contains, contains, decoration, decorations, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceText, replaceText, shadowColor, spliterator, spliterator, style

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Methods inherited from interface net.kyori.adventure.text.ScopedComponent

append, append, append, append, append, appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, decorationIfAbsent, decorations, font, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, shadowColor, shadowColorIfAbsent, style, style, style, style

Methods inherited from interface net.kyori.adventure.text.format.StyleSetter

decorate, decorations

Method Details

name

String name()

Gets the score name.

Returns:

the score name

Since:

4.0.0

name

@Contract(pure=true)
ScoreComponent name(String name)

Sets the score name.

Parameters:

name - the score name

Returns:

a score component

Since:

4.0.0

objective

String objective()

Gets the objective name.

Returns:

the objective name

Since:

4.0.0

objective

@Contract(pure=true)
ScoreComponent objective(String objective)

Sets the score objective.

Parameters:

objective - the score objective

Returns:

a score component

Since:

4.0.0

value

@Obsolete
@Nullable String value()

Gets the value.

Returns:

the value

Since:

4.0.0

Obsolete since Minecraft

1.16.5, no longer supported

value

@Obsolete
@Contract(pure=true)
ScoreComponent value(String value)

Sets the value.

Parameters:

value - the value

Returns:

a score component

Since:

4.0.0

Obsolete since Minecraft

1.16.5, no longer supported

toBuilder

ScoreComponent.Builder toBuilder()

Description copied from interface: Component

Returns a builder for this component.

Specified by:

toBuilder in interface Buildable<ScoreComponent.Builder>

Specified by:

toBuilder in interface BuildableComponent<ScoreComponent,ScoreComponent.Builder>

Specified by:

toBuilder in interface Component

Specified by:

toBuilder in interface ScopedComponent<ScoreComponent>

Returns:

the builder