me.lucko.helper.scoreboard

Interface Scoreboard<T extends ScoreboardTeam,O extends ScoreboardObjective>

All Known Implementing Classes:

PacketScoreboard

@NonnullByDefault
public interface Scoreboard<T extends ScoreboardTeam,O extends ScoreboardObjective>

Represents a Scoreboard on the server

Method Summary

Modifier and Type	Method and Description
default O	createObjective(String title, DisplaySlot displaySlot) Creates a new scoreboard objective with an automatically generated id
default O	createObjective(String title, DisplaySlot displaySlot, boolean autoSubscribe) Creates a new scoreboard objective with an automatically generated id
default O	createObjective(String id, String title, DisplaySlot displaySlot) Creates a new scoreboard objective
O	createObjective(String id, String title, DisplaySlot displaySlot, boolean autoSubscribe) Creates a new scoreboard objective
default O	createPlayerObjective(Player player, String title, DisplaySlot displaySlot) Creates a new per-player scoreboard objective with an automatically generated id
default O	createPlayerObjective(Player player, String title, DisplaySlot displaySlot, boolean autoSubscribe) Creates a new per-player scoreboard objective with an automatically generated id
default O	createPlayerObjective(Player player, String id, String title, DisplaySlot displaySlot) Creates a new per-player scoreboard objective
O	createPlayerObjective(Player player, String id, String title, DisplaySlot displaySlot, boolean autoSubscribe) Creates a new per-player scoreboard objective
default T	createPlayerTeam(Player player, String title) Creates a new per-player scoreboard team with an automatically generated id
default T	createPlayerTeam(Player player, String title, boolean autoSubscribe) Creates a new per-player scoreboard team with an automatically generated id
default T	createPlayerTeam(Player player, String id, String title) Creates a new per-player scoreboard team
T	createPlayerTeam(Player player, String id, String title, boolean autoSubscribe) Creates a new per-player scoreboard team
default T	createTeam(String title) Creates a new scoreboard team with an automatically generated id
default T	createTeam(String title, boolean autoSubscribe) Creates a new scoreboard team with an automatically generated id
default T	createTeam(String id, String title) Creates a new scoreboard team
T	createTeam(String id, String title, boolean autoSubscribe) Creates a new scoreboard team
static PacketScoreboard	get() Gets the global scoreboard instance.
O	getObjective(String id) Gets an existing scoreboard objective if one with the id exists
O	getPlayerObjective(Player player, String id) Gets an existing per-player scoreboard objective if one with the id exists
T	getPlayerTeam(Player player, String id) Gets an existing per-player scoreboard team if one with the id exists
T	getTeam(String id) Gets an existing scoreboard team if one with the id exists
boolean	removeObjective(String id) Removes a scoreboard objective from this scoreboard
boolean	removePlayerObjective(Player player, String id) Removes a per-player scoreboard objective from this scoreboard
boolean	removePlayerTeam(Player player, String id) Removes a per-player scoreboard team from this scoreboard
boolean	removeTeam(String id) Removes a scoreboard team from this scoreboard

Method Detail

get

@Nonnull
static PacketScoreboard get()

Gets the global scoreboard instance.

Returns:

the global scoreboard instance

createTeam

T createTeam(String id,
             String title,
             boolean autoSubscribe)

Creates a new scoreboard team

Parameters:

id - the id of the team

title - the initial title for the team

autoSubscribe - if players should be automatically subscribed

Returns:

the new team

Throws:

IllegalStateException - if a team with the same id already exists

createTeam

default T createTeam(String id,
                     String title)

Creates a new scoreboard team

Parameters:

id - the id of the team

title - the initial title for the team

Returns:

the new team

Throws:

IllegalStateException - if a team with the same id already exists

createTeam

default T createTeam(String title,
                     boolean autoSubscribe)

Creates a new scoreboard team with an automatically generated id

Parameters:

title - the initial title for the team

autoSubscribe - if players should be automatically subscribed

Returns:

the new team

createTeam

default T createTeam(String title)

Creates a new scoreboard team with an automatically generated id

Parameters:

title - the initial title for the team

Returns:

the new team

getTeam

@Nullable
T getTeam(String id)

Gets an existing scoreboard team if one with the id exists

Parameters:

id - the id of the team

Returns:

the team, if present, otherwise null

removeTeam

boolean removeTeam(String id)

Removes a scoreboard team from this scoreboard

Parameters:

id - the id of the team

Returns:

true if the team was removed successfully

createObjective

O createObjective(String id,
                  String title,
                  DisplaySlot displaySlot,
                  boolean autoSubscribe)

Creates a new scoreboard objective

Parameters:

id - the id of the objective

title - the initial title for the objective

displaySlot - the display slot to use for this objective

autoSubscribe - if players should be automatically subscribed

Returns:

the new objective

Throws:

IllegalStateException - if an objective with the same id already exists

createObjective

default O createObjective(String id,
                          String title,
                          DisplaySlot displaySlot)

Creates a new scoreboard objective

Parameters:

id - the id of the objective

title - the initial title for the objective

displaySlot - the display slot to use for this objective

Returns:

the new objective

Throws:

IllegalStateException - if an objective with the same id already exists

createObjective

default O createObjective(String title,
                          DisplaySlot displaySlot,
                          boolean autoSubscribe)

Creates a new scoreboard objective with an automatically generated id

Parameters:

title - the initial title for the objective

displaySlot - the display slot to use for this objective

autoSubscribe - if players should be automatically subscribed

Returns:

the new objective

createObjective

default O createObjective(String title,
                          DisplaySlot displaySlot)

Creates a new scoreboard objective with an automatically generated id

Parameters:

title - the initial title for the objective

displaySlot - the display slot to use for this objective

Returns:

the new objective

getObjective

@Nullable
O getObjective(String id)

Gets an existing scoreboard objective if one with the id exists

Parameters:

id - the id of the objective

Returns:

the objective, if present, otherwise null

removeObjective

boolean removeObjective(String id)

Removes a scoreboard objective from this scoreboard

Parameters:

id - the id of the objective

Returns:

true if the objective was removed successfully

createPlayerTeam

T createPlayerTeam(Player player,
                   String id,
                   String title,
                   boolean autoSubscribe)

Creates a new per-player scoreboard team

Parameters:

player - the player to make the team for

id - the id of the team

title - the initial title of the team

autoSubscribe - if players should be automatically subscribed

Returns:

the new team

Throws:

IllegalStateException - if a team with the same id already exists

createPlayerTeam

default T createPlayerTeam(Player player,
                           String id,
                           String title)

Creates a new per-player scoreboard team

Parameters:

player - the player to make the team for

id - the id of the team

title - the initial title of the team

Returns:

the new team

Throws:

IllegalStateException - if a team with the same id already exists

createPlayerTeam

default T createPlayerTeam(Player player,
                           String title,
                           boolean autoSubscribe)

Creates a new per-player scoreboard team with an automatically generated id

Parameters:

player - the player to make the team for

title - the initial title of the team

autoSubscribe - if players should be automatically subscribed

Returns:

the new team

createPlayerTeam

default T createPlayerTeam(Player player,
                           String title)

Creates a new per-player scoreboard team with an automatically generated id

Parameters:

player - the player to make the team for

title - the initial title of the team

Returns:

the new team

getPlayerTeam

@Nullable
T getPlayerTeam(Player player,
                           String id)

Gets an existing per-player scoreboard team if one with the id exists

Parameters:

player - the player to get the team for

id - the id of the team

Returns:

the team, if present, otherwise null

removePlayerTeam

boolean removePlayerTeam(Player player,
                         String id)

Removes a per-player scoreboard team from this scoreboard

Parameters:

player - the player to remove the team for

id - the id of the team

Returns:

true if the team was removed successfully

createPlayerObjective

O createPlayerObjective(Player player,
                        String id,
                        String title,
                        DisplaySlot displaySlot,
                        boolean autoSubscribe)

Creates a new per-player scoreboard objective

Parameters:

player - the player to make the objective for

id - the id of the objective

title - the initial title of the objective

displaySlot - the display slot to use for this objective

autoSubscribe - if players should be automatically subscribed

Returns:

the new objective

Throws:

IllegalStateException - if an objective with the same id already exists

createPlayerObjective

default O createPlayerObjective(Player player,
                                String id,
                                String title,
                                DisplaySlot displaySlot)

Creates a new per-player scoreboard objective

Parameters:

player - the player to make the objective for

id - the id of the objective

title - the initial title of the objective

displaySlot - the display slot to use for this objective

Returns:

the new objective

Throws:

IllegalStateException - if an objective with the same id already exists

createPlayerObjective

default O createPlayerObjective(Player player,
                                String title,
                                DisplaySlot displaySlot,
                                boolean autoSubscribe)

Creates a new per-player scoreboard objective with an automatically generated id

Parameters:

player - the player to make the objective for

title - the initial title of the objective

displaySlot - the display slot to use for this objective

Returns:

the new objective

createPlayerObjective

default O createPlayerObjective(Player player,
                                String title,
                                DisplaySlot displaySlot)

Creates a new per-player scoreboard objective with an automatically generated id

Parameters:

player - the player to make the objective for

title - the initial title of the objective

displaySlot - the display slot to use for this objective

Returns:

the new objective

getPlayerObjective

@Nullable
O getPlayerObjective(Player player,
                                String id)

Gets an existing per-player scoreboard objective if one with the id exists

Parameters:

player - the player to get the objective for

id - the id of the objective

Returns:

the objective, if present, otherwise null

removePlayerObjective

boolean removePlayerObjective(Player player,
                              String id)

Removes a per-player scoreboard objective from this scoreboard

Parameters:

player - the player to remove the objective for

id - the id of the objective

Returns:

true if the objective was removed successfully