silk-game/net.silkmc.silk.game.sideboard

Package-level declarations

Types

class ~~ChangingSideboardLine~~(val textFlow: Flow<Component>) : SideboardLine

A sideboard line which does change. Everytime the given textFlow emits a new Text, the sideboard line will be updated for all players currently seeing the Sideboard.

Sideboard

class Sideboard(name: String, displayName: Component, numberFormat: NumberFormat, lines: List<SideboardLine>)

A sideboard which can be displayed to a variable collection of players using the displayToPlayer function. A sideboard is an abstraction of Minecraft's server side scoreboards displayed on the right-hand side of the screen.

SideboardBuilder

class SideboardBuilder

A helper class which is used to create a Sideboard.

SideboardLine

interface SideboardLine

This interface represents one line in a Sideboard.

SimpleSideboardLine

class ~~SimpleSideboardLine~~(text: Component) : SideboardLine

A sideboard line which does not change and always displays the same Text.

Functions

showSideboard

fun ServerPlayer.~~showSideboard~~(sideboard: Sideboard)

Displays the given sideboard to the player. Future updates will be visible to the player as well.

sideboard

inline fun sideboard(displayName: Component, name: String = displayName.string.filter { it.isLetter() }.take(16), numberFormat: NumberFormat = BlankFormat.INSTANCE, builder: SideboardBuilder.() -> Unit): Sideboard

Opens a new sideboard builder and returns the final sideboard.