fr.minuskube.netherboard

Class Netherboard

java.lang.Object

fr.minuskube.netherboard.Netherboard

public class Netherboard
extends java.lang.Object

The main class of the Netherboard API for Bukkit, you'll need to use it if you want to create boards. To create a board, get the instance using Netherboard.instance() and call one of the createBoard() methods.

Method Summary

Modifier and Type	Method and Description
BPlayerBoard	createBoard(org.bukkit.entity.Player player, org.bukkit.scoreboard.Scoreboard scoreboard, java.lang.String name) Creates a board to a player, using a predefined scoreboard.
BPlayerBoard	createBoard(org.bukkit.entity.Player player, java.lang.String name) Creates a board to a player.
void	deleteBoard(org.bukkit.entity.Player player) Deletes the board of a player.
BPlayerBoard	getBoard(org.bukkit.entity.Player player) Gets the board of a player.
java.util.Map<org.bukkit.entity.Player,BPlayerBoard>	getBoards() Gets all the boards mapped to their player.
boolean	hasBoard(org.bukkit.entity.Player player) Checks if the player has a board.
static Netherboard	instance() Returns the instance of the Netherboard class.
void	removeBoard(org.bukkit.entity.Player player) Removes the board of a player from the boards map.

Methods inherited from class java.lang.Object

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

Method Detail

createBoard

public BPlayerBoard createBoard(org.bukkit.entity.Player player,
                                java.lang.String name)

Creates a board to a player.

Parameters:

player - the player

name - the name of the board

Returns:

the newly created board

createBoard

public BPlayerBoard createBoard(org.bukkit.entity.Player player,
                                org.bukkit.scoreboard.Scoreboard scoreboard,
                                java.lang.String name)

Creates a board to a player, using a predefined scoreboard.

Parameters:

player - the player

scoreboard - the scoreboard to use

name - the name of the board

Returns:

the newly created board

deleteBoard

public void deleteBoard(org.bukkit.entity.Player player)

Deletes the board of a player.

Parameters:

player - the player

removeBoard

public void removeBoard(org.bukkit.entity.Player player)

Removes the board of a player from the boards map.
WARNING: Do not use this to delete the board of a player!

Parameters:

player - the player

hasBoard

public boolean hasBoard(org.bukkit.entity.Player player)

Checks if the player has a board.

Parameters:

player - the player

Returns:

true if the player has a board, otherwise false

getBoard

public BPlayerBoard getBoard(org.bukkit.entity.Player player)

Gets the board of a player.

Parameters:

player - the player

Returns:

the player board, or null if the player has no board

getBoards

public java.util.Map<org.bukkit.entity.Player,BPlayerBoard> getBoards()

Gets all the boards mapped to their player. This returns a copy of the current boards map, thus modifying the given Map will not have any effect on the boards.

Returns:

a new map with all the player boards

instance

public static Netherboard instance()

Returns the instance of the Netherboard class.

Returns:

the instance