fr.maxlego08.znexus.scoreboard

Class FastBoard

java.lang.Object

fr.maxlego08.znexus.scoreboard.FastBoard

public class FastBoard
extends java.lang.Object

Simple Bukkit ScoreBoard API with 1.7 to 1.15 support ! Everything is at packet level so you don't need to use it in the main server thread.

You can find the project on GitHub

Author:

MrMicky

Constructor Summary

Constructors

Constructor and Description
FastBoard(org.bukkit.entity.Player player) Creates a new FastBoard.

Method Summary

Modifier and Type	Method and Description
void	delete() Delete this FastBoard, and will remove the scoreboard for the associated player if he is online.
java.lang.String	getId() Get the scoreboard id.
java.lang.String	getLine(int line) Get the specified scoreboard line.
java.util.List<java.lang.String>	getLines() Get the scoreboard lines.
org.bukkit.entity.Player	getPlayer() Get the player who has the scoreboard.
java.lang.String	getTitle() Get the scoreboard title.
boolean	isDeleted() Get if the scoreboard is deleted.
void	removeLine(int line) Remove a scoreboard line.
int	size() Get the scoreboard size (the number of lines).
void	updateLine(int line, java.lang.String text) Update a single scoreboard line.
void	updateLines(java.util.Collection<java.lang.String> lines) Update the lines of the scoreboard
void	updateLines(java.lang.String... lines) Update all the scoreboard lines.
void	updateTitle(java.lang.String title) Update the scoreboard title.

Methods inherited from class java.lang.Object

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

Constructor Detail

FastBoard

public FastBoard(org.bukkit.entity.Player player)

Creates a new FastBoard.

Parameters:

player - the player the scoreboard is for

Method Detail

getTitle

public java.lang.String getTitle()

Get the scoreboard title.

Returns:

the scoreboard title

updateTitle

public void updateTitle(java.lang.String title)

Update the scoreboard title.

Parameters:

title - the new scoreboard title

Throws:

java.lang.IllegalArgumentException - if the title is longer than 32 chars on 1.12 or lower

java.lang.IllegalStateException - if delete() was call before

getLines

public java.util.List<java.lang.String> getLines()

Get the scoreboard lines.

Returns:

the scoreboard lines

getLine

public java.lang.String getLine(int line)

Get the specified scoreboard line.

Parameters:

line - the line number

Returns:

the line

Throws:

java.lang.IndexOutOfBoundsException - if the line is higher than size

updateLine

public void updateLine(int line,
                       java.lang.String text)

Update a single scoreboard line.

Parameters:

line - the line number

text - the new line text

Throws:

java.lang.IndexOutOfBoundsException - if the line is higher than size + 1

removeLine

public void removeLine(int line)

Remove a scoreboard line.

Parameters:

line - the line number

updateLines

public void updateLines(java.lang.String... lines)

Update all the scoreboard lines.

Parameters:

lines - the new lines

Throws:

java.lang.IllegalArgumentException - if one line is longer than 30 chars on 1.12 or lower

java.lang.IllegalStateException - if delete() was call before

updateLines

public void updateLines(java.util.Collection<java.lang.String> lines)

Update the lines of the scoreboard

Parameters:

lines - the new scoreboard lines

Throws:

java.lang.IllegalArgumentException - if one line is longer than 30 chars on 1.12 or lower

java.lang.IllegalStateException - if delete() was call before

getPlayer

public org.bukkit.entity.Player getPlayer()

Get the player who has the scoreboard.

Returns:

current player for this FastBoard

getId

public java.lang.String getId()

Get the scoreboard id.

Returns:

the id

isDeleted

public boolean isDeleted()

Get if the scoreboard is deleted.

Returns:

true if the scoreboard is deleted

size

public int size()

Get the scoreboard size (the number of lines).

Returns:

the size

delete

public void delete()

Delete this FastBoard, and will remove the scoreboard for the associated player if he is online. After this, all uses of updateLines(java.lang.String...) and updateTitle(java.lang.String) will throws an IllegalStateException

Throws:

java.lang.IllegalStateException - if this was already call before