Package me.hsgamer.hscore.minestom.board

Class Board

java.lang.Object

me.hsgamer.hscore.minestom.board.Board

public class Board
extends Object

A simple scoreboard for Minestom. Call hook(EventNode) when the server is starting up to make sure the feature work properly.

Constructor Summary

Constructors

Constructor	Description
Board(Function<net.minestom.server.entity.Player,net.kyori.adventure.text.Component> title, Function<net.minestom.server.entity.Player,List<net.kyori.adventure.text.Component>> lines)	Create a new board

Method Summary

Modifier and Type	Method	Description
void	addPlayer(net.minestom.server.entity.Player player)	Add the player to the board
static void	hook(net.minestom.server.event.EventNode<net.minestom.server.event.Event> node)	Hook the board event to the event node.
void	removeAll()	Remove all the players from the board
void	removePlayer(net.minestom.server.entity.Player player)	Remove the player from the board
boolean	update(net.minestom.server.entity.Player player)	Update the board for the player
void	updateAll()	Update the board for all the players

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Board

public Board(Function<net.minestom.server.entity.Player,net.kyori.adventure.text.Component> title,
 Function<net.minestom.server.entity.Player,List<net.kyori.adventure.text.Component>> lines)

Create a new board

Parameters:

title - the title supplier

lines - the lines supplier

Method Details

hook

public static void hook(net.minestom.server.event.EventNode<net.minestom.server.event.Event> node)

Hook the board event to the event node. Call the method when the server is starting up to hook the event and make sure the function work properly.

Parameters:

node - the event node

addPlayer

public void addPlayer(net.minestom.server.entity.Player player)

Add the player to the board

Parameters:

player - the player

removePlayer

public void removePlayer(net.minestom.server.entity.Player player)

Remove the player from the board

Parameters:

player - the player

removeAll

public void removeAll()

Remove all the players from the board

update

public boolean update(net.minestom.server.entity.Player player)

Update the board for the player

Parameters:

player - the player

Returns:

true if the board was updated, false if the player is not in the board

updateAll

public void updateAll()

Update the board for all the players