me.lucko.helper.scoreboard

Interface Scoreboard

All Known Implementing Classes:

PacketScoreboard

@NonnullByDefault
public interface Scoreboard

Represents a Scoreboard on the server

Method Summary

Modifier and Type	Method and Description
default ScoreboardObjective	createObjective(String title, org.bukkit.scoreboard.DisplaySlot displaySlot) Creates a new scoreboard objective with an automatically generated id
default ScoreboardObjective	createObjective(String title, org.bukkit.scoreboard.DisplaySlot displaySlot, boolean autoSubscribe) Creates a new scoreboard objective with an automatically generated id
default ScoreboardObjective	createObjective(String id, String title, org.bukkit.scoreboard.DisplaySlot displaySlot) Creates a new scoreboard objective
ScoreboardObjective	createObjective(String id, String title, org.bukkit.scoreboard.DisplaySlot displaySlot, boolean autoSubscribe) Creates a new scoreboard objective
default ScoreboardObjective	createPlayerObjective(org.bukkit.entity.Player player, String title, org.bukkit.scoreboard.DisplaySlot displaySlot) Creates a new per-player scoreboard objective with an automatically generated id
default ScoreboardObjective	createPlayerObjective(org.bukkit.entity.Player player, String title, org.bukkit.scoreboard.DisplaySlot displaySlot, boolean autoSubscribe) Creates a new per-player scoreboard objective with an automatically generated id
default ScoreboardObjective	createPlayerObjective(org.bukkit.entity.Player player, String id, String title, org.bukkit.scoreboard.DisplaySlot displaySlot) Creates a new per-player scoreboard objective
ScoreboardObjective	createPlayerObjective(org.bukkit.entity.Player player, String id, String title, org.bukkit.scoreboard.DisplaySlot displaySlot, boolean autoSubscribe) Creates a new per-player scoreboard objective
default ScoreboardTeam	createPlayerTeam(org.bukkit.entity.Player player, String title) Creates a new per-player scoreboard team with an automatically generated id
default ScoreboardTeam	createPlayerTeam(org.bukkit.entity.Player player, String title, boolean autoSubscribe) Creates a new per-player scoreboard team with an automatically generated id
default ScoreboardTeam	createPlayerTeam(org.bukkit.entity.Player player, String id, String title) Creates a new per-player scoreboard team
ScoreboardTeam	createPlayerTeam(org.bukkit.entity.Player player, String id, String title, boolean autoSubscribe) Creates a new per-player scoreboard team
default ScoreboardTeam	createTeam(String title) Creates a new scoreboard team with an automatically generated id
default ScoreboardTeam	createTeam(String title, boolean autoSubscribe) Creates a new scoreboard team with an automatically generated id
default ScoreboardTeam	createTeam(String id, String title) Creates a new scoreboard team
ScoreboardTeam	createTeam(String id, String title, boolean autoSubscribe) Creates a new scoreboard team
ScoreboardObjective	getObjective(String id) Gets an existing scoreboard objective if one with the id exists
ScoreboardObjective	getPlayerObjective(org.bukkit.entity.Player player, String id) Gets an existing per-player scoreboard objective if one with the id exists
ScoreboardTeam	getPlayerTeam(org.bukkit.entity.Player player, String id) Gets an existing per-player scoreboard team if one with the id exists
ScoreboardTeam	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(org.bukkit.entity.Player player, String id) Removes a per-player scoreboard objective from this scoreboard
boolean	removePlayerTeam(org.bukkit.entity.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

createTeam

ScoreboardTeam 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 ScoreboardTeam 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 ScoreboardTeam 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 ScoreboardTeam 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
ScoreboardTeam 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

ScoreboardObjective createObjective(String id,
                                    String title,
                                    org.bukkit.scoreboard.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 ScoreboardObjective createObjective(String id,
                                            String title,
                                            org.bukkit.scoreboard.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 ScoreboardObjective createObjective(String title,
                                            org.bukkit.scoreboard.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 ScoreboardObjective createObjective(String title,
                                            org.bukkit.scoreboard.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
ScoreboardObjective 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

ScoreboardTeam createPlayerTeam(org.bukkit.entity.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 ScoreboardTeam createPlayerTeam(org.bukkit.entity.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 ScoreboardTeam createPlayerTeam(org.bukkit.entity.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 ScoreboardTeam createPlayerTeam(org.bukkit.entity.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
ScoreboardTeam getPlayerTeam(org.bukkit.entity.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(org.bukkit.entity.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

ScoreboardObjective createPlayerObjective(org.bukkit.entity.Player player,
                                          String id,
                                          String title,
                                          org.bukkit.scoreboard.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 ScoreboardObjective createPlayerObjective(org.bukkit.entity.Player player,
                                                  String id,
                                                  String title,
                                                  org.bukkit.scoreboard.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 ScoreboardObjective createPlayerObjective(org.bukkit.entity.Player player,
                                                  String title,
                                                  org.bukkit.scoreboard.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 ScoreboardObjective createPlayerObjective(org.bukkit.entity.Player player,
                                                  String title,
                                                  org.bukkit.scoreboard.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
ScoreboardObjective getPlayerObjective(org.bukkit.entity.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(org.bukkit.entity.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