vital-scoreboards/dev.vitalframework.scoreboards/VitalPlayerScoreboard

VitalPlayerScoreboard

class VitalPlayerScoreboard(title: Function<SpigotPlayer, String>, lines: Function<SpigotPlayer, String>)

Defines a per-player based scoreboard implementation within the Vital-Framework. Per-played scoreboards should be used when displaying data, that is tied to a specific player on the server.

@Bean
public VitalPlayerScoreboard myPlayerScoreboard() {
  return new VitalPlayerScoreboard(
    player -> "Title for player " + player.getName(),
    player -> "Line 1 for " + player.getName(),
    player -> "Line 2 for " + player.getName(),
    player -> "Line 3 for " + player.getName()
  );
}

Constructors

constructor(title: Function<SpigotPlayer, String>, vararg lines: Function<SpigotPlayer, String>)

Properties

lines

var lines: Array<out Function<SpigotPlayer, String>>

The lines-functions for this scoreboard. If modified, calls the update function to automatically update this scoreboard for all players.

scoreboards

val scoreboards: Map<UUID, VitalScoreboard>

title

var title: Function<SpigotPlayer, String>

The title function for this scoreboard. If modified, calls the update function to automatically update this scoreboard for all players.

Functions

addPlayer

@JvmOverloads

fun addPlayer(player: SpigotPlayer, update: Boolean = true)

Adds the given player to this scoreboard. If the given player is already in this scoreboard, this function will override that scoreboard.

removePlayer

@JvmOverloads

fun removePlayer(player: SpigotPlayer, update: Boolean = true)

Removes the given player from this scoreboard. If the given player is not in this scoreboard, this function does nothing.

update

fun update()

Updates this scoreboard for all players. If this scoreboard has no players, this function does nothing.

fun update(player: SpigotPlayer)

Updates this scoreboard for the given player. If the given player is not in this scoreboard, this function does nothing.