net.glowstone.scoreboard

Class GlowObjective

java.lang.Object

net.glowstone.scoreboard.GlowObjective

All Implemented Interfaces:

org.bukkit.scoreboard.Objective

public final class GlowObjective
extends Object
implements org.bukkit.scoreboard.Objective

Scoreboard objective and associated data.

Constructor Summary

Constructors

Constructor and Description
GlowObjective(GlowScoreboard scoreboard, String name, String criteria) Creates a scoreboard objective.

Method Summary

Modifier and Type	Method and Description
String	getCriteria()
String	getDisplayName()
org.bukkit.scoreboard.DisplaySlot	getDisplaySlot()
Set<String>	getEntries()
String	getName()
org.bukkit.scoreboard.Score	getScore(org.bukkit.OfflinePlayer player) Deprecated.
org.bukkit.scoreboard.Score	getScore(String entry) Returns a score, creating it if necessary.
GlowScoreboard	getScoreboard()
RenderType	getType()
boolean	hasScore(String entry) Returns whether a score is defined.
boolean	isModifiable()
void	setDisplayName(String displayName) Sets the display name.
void	setDisplaySlot(org.bukkit.scoreboard.DisplaySlot slot) Sets the DisplaySlot where this objective displays.
void	setRenderType(String renderType)
void	setType(RenderType renderType) Sets the RenderType for this objective.
void	unregister() Removes this objective from the scoreboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlowObjective

public GlowObjective(GlowScoreboard scoreboard,
                     String name,
                     String criteria)

Creates a scoreboard objective.

Parameters:

scoreboard - the scoreboard to add to

name - the name of the objective

criteria - one of the constants from Criterias, or anything else if this score is only modified by commands and/or plugins.

Method Detail

unregister

public void unregister()
                throws IllegalStateException

Removes this objective from the scoreboard.

Specified by:

unregister in interface org.bukkit.scoreboard.Objective

Throws:

IllegalStateException - if this objective already isn't registered with a scoreboard

getName

public String getName()
               throws IllegalStateException

Specified by:

getName in interface org.bukkit.scoreboard.Objective

Throws:

IllegalStateException

getCriteria

public String getCriteria()
                   throws IllegalStateException

Specified by:

getCriteria in interface org.bukkit.scoreboard.Objective

Throws:

IllegalStateException

getDisplayName

public String getDisplayName()
                      throws IllegalStateException

Specified by:

getDisplayName in interface org.bukkit.scoreboard.Objective

Throws:

IllegalStateException

setDisplayName

public void setDisplayName(String displayName)
                    throws IllegalStateException,
                           IllegalArgumentException

Sets the display name.

Specified by:

setDisplayName in interface org.bukkit.scoreboard.Objective

Parameters:

displayName - the new display name, up to 32 characters long

Throws:

IllegalArgumentException - if displayName is null or longer than 32 characters

IllegalStateException - if this objective isn't registered with a scoreboard

getDisplaySlot

public org.bukkit.scoreboard.DisplaySlot getDisplaySlot()
                                                 throws IllegalStateException

Specified by:

getDisplaySlot in interface org.bukkit.scoreboard.Objective

Throws:

IllegalStateException

setDisplaySlot

public void setDisplaySlot(org.bukkit.scoreboard.DisplaySlot slot)
                    throws IllegalStateException

Sets the DisplaySlot where this objective displays.

Specified by:

setDisplaySlot in interface org.bukkit.scoreboard.Objective

Parameters:

slot - the DisplaySlot, or null to hide the objective

Throws:

IllegalStateException - if this objective isn't registered with a scoreboard

getType

public RenderType getType()
                   throws IllegalStateException

Throws:

IllegalStateException

setType

public void setType(RenderType renderType)
             throws IllegalStateException

Sets the RenderType for this objective.

Parameters:

renderType - the new render type

Throws:

IllegalArgumentException - if renderType is null

IllegalStateException - if this objective isn't registered with a scoreboard

isModifiable

public boolean isModifiable()
                     throws IllegalStateException

Specified by:

isModifiable in interface org.bukkit.scoreboard.Objective

Throws:

IllegalStateException

getScore

public org.bukkit.scoreboard.Score getScore(String entry)
                                     throws IllegalArgumentException,
                                            IllegalStateException

Returns a score, creating it if necessary.

Specified by:

getScore in interface org.bukkit.scoreboard.Objective

Parameters:

entry - the key (e.g. player name or team name)

Returns:

the score for entry

Throws:

IllegalArgumentException - if entry is null

IllegalStateException - if this objective isn't registered with a scoreboard

getScore

@Deprecated
public org.bukkit.scoreboard.Score getScore(org.bukkit.OfflinePlayer player)
                                                 throws IllegalArgumentException,
                                                        IllegalStateException

Deprecated.

Specified by:

getScore in interface org.bukkit.scoreboard.Objective

Throws:

IllegalArgumentException

IllegalStateException

setRenderType

public void setRenderType(String renderType)

hasScore

public boolean hasScore(String entry)
                 throws IllegalArgumentException,
                        IllegalStateException

Returns whether a score is defined.

Parameters:

entry - the key (e.g. player name or team name)

Returns:

true if the score exists; false otherwise

Throws:

IllegalArgumentException - if entry is null

IllegalStateException - if this objective isn't registered with a scoreboard

getEntries

public Set<String> getEntries()
                       throws IllegalStateException

Throws:

IllegalStateException

getScoreboard

public GlowScoreboard getScoreboard()

Specified by:

getScoreboard in interface org.bukkit.scoreboard.Objective