me.lucko.helper.scoreboard

Class PacketScoreboard

java.lang.Object

me.lucko.helper.scoreboard.PacketScoreboard

All Implemented Interfaces:

Scoreboard

@NonnullByDefault
public class PacketScoreboard
extends Object
implements Scoreboard

Implements Scoreboard using ProtocolLib.

This class as well as all returned instances are thread safe.

Constructor Summary

Constructors

Constructor and Description
PacketScoreboard(HelperPlugin plugin)

Method Summary

Modifier and Type	Method and Description
PacketScoreboardObjective	createObjective(String id, String title, DisplaySlot displaySlot, boolean autoSubscribe) Creates a new scoreboard objective
PacketScoreboardObjective	createPlayerObjective(Player player, String id, String title, DisplaySlot displaySlot, boolean autoSubscribe) Creates a new per-player scoreboard objective
PacketScoreboardTeam	createPlayerTeam(Player player, String id, String title, boolean autoSubscribe) Creates a new per-player scoreboard team
PacketScoreboardTeam	createTeam(String id, String title, boolean autoSubscribe) Creates a new scoreboard team
PacketScoreboardObjective	getObjective(String id) Gets an existing scoreboard objective if one with the id exists
PacketScoreboardObjective	getPlayerObjective(Player player, String id) Gets an existing per-player scoreboard objective if one with the id exists
PacketScoreboardTeam	getPlayerTeam(Player player, String id) Gets an existing per-player scoreboard team if one with the id exists
PacketScoreboardTeam	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.lucko.helper.scoreboard.Scoreboard

createObjective, createObjective, createObjective, createPlayerObjective, createPlayerObjective, createPlayerObjective, createPlayerTeam, createPlayerTeam, createPlayerTeam, createTeam, createTeam, createTeam

Constructor Detail

PacketScoreboard

public PacketScoreboard(@Nonnull
                        HelperPlugin plugin)

Method Detail

createTeam

public PacketScoreboardTeam createTeam(String id,
                                       String title,
                                       boolean autoSubscribe)

Description copied from interface: Scoreboard

Creates a new scoreboard team

Specified by:

createTeam in interface Scoreboard

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

getTeam

@Nullable
public PacketScoreboardTeam getTeam(String id)

Description copied from interface: Scoreboard

Gets an existing scoreboard team if one with the id exists

Specified by:

getTeam in interface Scoreboard

Parameters:

id - the id of the team

Returns:

the team, if present, otherwise null

removeTeam

public boolean removeTeam(String id)

Description copied from interface: Scoreboard

Removes a scoreboard team from this scoreboard

Specified by:

removeTeam in interface Scoreboard

Parameters:

id - the id of the team

Returns:

true if the team was removed successfully

createObjective

public PacketScoreboardObjective createObjective(String id,
                                                 String title,
                                                 DisplaySlot displaySlot,
                                                 boolean autoSubscribe)

Description copied from interface: Scoreboard

Creates a new scoreboard objective

Specified by:

createObjective in interface Scoreboard

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

getObjective

@Nullable
public PacketScoreboardObjective getObjective(String id)

Description copied from interface: Scoreboard

Gets an existing scoreboard objective if one with the id exists

Specified by:

getObjective in interface Scoreboard

Parameters:

id - the id of the objective

Returns:

the objective, if present, otherwise null

removeObjective

public boolean removeObjective(String id)

Description copied from interface: Scoreboard

Removes a scoreboard objective from this scoreboard

Specified by:

removeObjective in interface Scoreboard

Parameters:

id - the id of the objective

Returns:

true if the objective was removed successfully

createPlayerTeam

public PacketScoreboardTeam createPlayerTeam(Player player,
                                             String id,
                                             String title,
                                             boolean autoSubscribe)

Description copied from interface: Scoreboard

Creates a new per-player scoreboard team

Specified by:

createPlayerTeam in interface Scoreboard

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

getPlayerTeam

@Nullable
public PacketScoreboardTeam getPlayerTeam(Player player,
                                                    String id)

Description copied from interface: Scoreboard

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

Specified by:

getPlayerTeam in interface Scoreboard

Parameters:

player - the player to get the team for

id - the id of the team

Returns:

the team, if present, otherwise null

removePlayerTeam

public boolean removePlayerTeam(Player player,
                                String id)

Description copied from interface: Scoreboard

Removes a per-player scoreboard team from this scoreboard

Specified by:

removePlayerTeam in interface 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

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

Description copied from interface: Scoreboard

Creates a new per-player scoreboard objective

Specified by:

createPlayerObjective in interface Scoreboard

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

getPlayerObjective

@Nullable
public PacketScoreboardObjective getPlayerObjective(Player player,
                                                              String id)

Description copied from interface: Scoreboard

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

Specified by:

getPlayerObjective in interface Scoreboard

Parameters:

player - the player to get the objective for

id - the id of the objective

Returns:

the objective, if present, otherwise null

removePlayerObjective

public boolean removePlayerObjective(Player player,
                                     String id)

Description copied from interface: Scoreboard

Removes a per-player scoreboard objective from this scoreboard

Specified by:

removePlayerObjective in interface Scoreboard

Parameters:

player - the player to remove the objective for

id - the id of the objective

Returns:

true if the objective was removed successfully