vital-scoreboards/dev.vitalframework.scoreboards/VitalGlobalScoreboard

VitalGlobalScoreboard

class VitalGlobalScoreboard(title: Supplier<String>, lines: Supplier<String>) : VitalScoreboard

Defines a global scoreboard implementation within the Vital-Framework. Global scoreboards should be used when displaying data, that is not tied to a specific player.

@Bean
public VitalGlobalScoreboard myGlobalScoreboard() {
  return new VitalGlobalScoreboard(
    () -> "MyGlobalScoreboard",
    () -> "Line 1",
    () -> "Line 2",
    () -> "Line 3"
  );
}

Constructors

constructor(title: Supplier<String>, vararg lines: Supplier<String>)

Properties

bukkitScoreboard

val bukkitScoreboard: @NotNull Scoreboard

open override var id: UUID

lines

var lines: Array<out Supplier<String>>

title

var title: Supplier<String>

Functions

addPlayer

@JvmOverloads

fun addPlayer(player: SpigotPlayer, title: Supplier<String>? = null, lines: Supplier<List<String>>? = null)

Internal function; adds the given player to this scoreboard and updates it via update. This function will only update this scoreboard if both title and lines are set. If the given player is already in this scoreboard, this function does nothing.

addTeam

@JvmOverloads

fun addTeam(name: String, title: Supplier<String>? = null, lines: Supplier<List<String>>? = null, init: Consumer<Team>)

Internal function; adds a new team with the given name to this scoreboard. This function will only update this scoreboard if both title and lines are set. If the given team is already in this scoreboard, this function does nothing.

removePlayer

@JvmOverloads

fun removePlayer(player: SpigotPlayer, title: Supplier<String>? = null, lines: Supplier<List<String>>? = null)

Internal function; removes the given player from this scoreboard and updates it via update. This function will only update this scoreboard if both title and lines are set. If the given player is not in this scoreboard, this function does nothing.

removeTeam

@JvmOverloads

fun removeTeam(name: String, title: Supplier<String>? = null, lines: Supplier<List<String>>? = null)

Internal function; removes the team with the given name from this scoreboard. This function will only update this scoreboard if both title and lines are set. If the given team is not in this scoreboard, this function does nothing.

update

fun update(_title: Supplier<String>, _lines: Supplier<List<String>>): Objective

Updates this scoreboard with the given _title and _lines.