SurfScoreboardBuilder

The SurfScoreboardBuilder interface provides methods to build a SurfScoreboard, a SurfAutoUpdatableScoreboard, or a SurfAutoUpdatablePlayerScoreboard.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
abstract fun addAnimatedLine(frames: MutableList<Component>): SurfScoreboardBuilder

Adds an animated line to the scoreboard. The animated line will display a series of frames, where each frame is a component. The frames will be displayed consecutively in an animated manner.

abstract fun addAnimatedLine(animation: SidebarAnimation<SidebarComponent>): SurfScoreboardBuilder

Adds an animated line to the SurfScoreboardBuilder.

Link copied to clipboard

Adds an empty line to the SurfScoreboardBuilder.

Link copied to clipboard
abstract fun addGradientLine(text: Component, start: TextColor, end: TextColor): SurfScoreboardBuilder

Adds a gradient line to the SurfScoreboardBuilder. The gradient color starts with the specified start color and gradually transitions to the specified end color.

Link copied to clipboard
abstract fun addLine(line: Component): SurfScoreboardBuilder

Adds a line to the SurfScoreboardBuilder.

Link copied to clipboard

Adds a line separator to the SurfScoreboardBuilder. This method adds a gradient line separator composed of '-' characters to the SurfScoreboardBuilder. The default colors for the gradient are Colors.WHITE and Colors.SPACER.

Link copied to clipboard
abstract fun addUpdatableLine(line: Supplier<Component>): SurfScoreboardBuilder

Adds an updatable line to the scoreboard. An updatable line is a line that can be dynamically updated by supplying a Supplier that returns the updated content.

Link copied to clipboard
abstract fun build(): SurfScoreboard

Builds a SurfScoreboard.

Link copied to clipboard

Builds an auto-updatable scoreboard.

Link copied to clipboard

Builds an auto-updatable player scoreboard.

Link copied to clipboard
abstract fun maxLines(maxLines: @Range(from = 1, to = 15) Int): SurfScoreboardBuilder

Sets the maximum number of lines for the scoreboard.