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

Sideboard

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

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.

Note: You probably want to build this class using the sideboard builder API. See sideboard!

Constructors

Sideboard

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

Properties

scoreboard

val scoreboard: SideboardScoreboard

Functions

displayToPlayer

fun displayToPlayer(player: ServerPlayer)

Shows this sideboard to the given player. This registers the player for receiving updates on the sideboard, until he leaves the server.

hideFromPlayer

fun hideFromPlayer(player: ServerPlayer)

Hides this sideboard from the given player. This also unregisters the player from receiving any further updates on the sideboard.