net.kyori.text

Interface ScoreComponent

All Superinterfaces:

BuildableComponent<ScoreComponent,ScoreComponent.Builder>, Component, ScopedComponent<ScoreComponent>

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

A scoreboard score component.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static @NonNull ScoreComponent.Builder	builder() Creates a score component builder.
static @NonNull ScoreComponent.Builder	builder(@NonNull java.lang.String name, @NonNull java.lang.String objective) Creates a score component builder with a name and objective.
static @NonNull ScoreComponent	make(@NonNull java.util.function.Consumer<? super ScoreComponent.Builder> consumer) Creates a score component by applying configuration from consumer.
static @NonNull ScoreComponent	make(@NonNull java.lang.String name, @NonNull java.lang.String objective, @NonNull java.util.function.Consumer<? super ScoreComponent.Builder> consumer) Creates a score component by applying configuration from consumer.
@NonNull java.lang.String	name() Gets the score name.
@NonNull ScoreComponent	name(@NonNull java.lang.String name) Sets the score name.
@NonNull java.lang.String	objective() Gets the objective name.
@NonNull ScoreComponent	objective(@NonNull java.lang.String objective) Sets the score objective.
static @NonNull ScoreComponent	of(@NonNull java.lang.String name, @NonNull java.lang.String objective) Creates a score component with a name and objective.
static @NonNull ScoreComponent	of(@NonNull java.lang.String name, @NonNull java.lang.String objective, @Nullable java.lang.String value) Creates a score component with a name, objective, and optional value.
@Nullable java.lang.String	value() Gets the value.
@NonNull ScoreComponent	value(@NonNull java.lang.String value) Sets the value.

Methods inherited from interface net.kyori.text.BuildableComponent

toBuilder

Methods inherited from interface net.kyori.text.ScopedComponent

append, append, children, clickEvent, color, decoration, decoration, hoverEvent, insertion, mergeColor, mergeDecorations, mergeEvents

Methods inherited from interface net.kyori.text.Component

children, clickEvent, color, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, style, style

Method Detail

builder

static @NonNull ScoreComponent.Builder builder()

Creates a score component builder.

Returns:

a builder

builder

static @NonNull ScoreComponent.Builder builder(@NonNull java.lang.String name,
                                               @NonNull java.lang.String objective)

Creates a score component builder with a name and objective.

Parameters:

name - the score name

objective - the score objective

Returns:

a builder

of

static @NonNull ScoreComponent of(@NonNull java.lang.String name,
                                  @NonNull java.lang.String objective)

Creates a score component with a name and objective.

Parameters:

name - the score name

objective - the score objective

Returns:

the score component

of

static @NonNull ScoreComponent of(@NonNull java.lang.String name,
                                  @NonNull java.lang.String objective,
                                  @Nullable java.lang.String value)

Creates a score component with a name, objective, and optional value.

Parameters:

name - the score name

objective - the score objective

value - the value

Returns:

the score component

make

static @NonNull ScoreComponent make(@NonNull java.util.function.Consumer<? super ScoreComponent.Builder> consumer)

Creates a score component by applying configuration from consumer.

Parameters:

consumer - the builder configurator

Returns:

the score component

make

static @NonNull ScoreComponent make(@NonNull java.lang.String name,
                                    @NonNull java.lang.String objective,
                                    @NonNull java.util.function.Consumer<? super ScoreComponent.Builder> consumer)

Creates a score component by applying configuration from consumer.

Parameters:

name - the score name

objective - the score objective

consumer - the builder configurator

Returns:

the score component

name

@NonNull java.lang.String name()

Gets the score name.

Returns:

the score name

name

@NonNull ScoreComponent name(@NonNull java.lang.String name)

Sets the score name.

Parameters:

name - the score name

Returns:

a copy of this component

objective

@NonNull java.lang.String objective()

Gets the objective name.

Returns:

the objective name

objective

@NonNull ScoreComponent objective(@NonNull java.lang.String objective)

Sets the score objective.

Parameters:

objective - the score objective

Returns:

a copy of this component

value

@Nullable java.lang.String value()

Gets the value.

Returns:

the value

value

@NonNull ScoreComponent value(@NonNull java.lang.String value)

Sets the value.

Parameters:

value - the value

Returns:

a copy of this component