Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.scoreboard.Scoreboard Interface Reference

Public Member Functions

Objective registerNewObjective (String name, String criteria) throws IllegalArgumentException
 
Objective getObjective (String name) throws IllegalArgumentException
 
Set< ObjectivegetObjectivesByCriteria (String criteria) throws IllegalArgumentException
 
Set< ObjectivegetObjectives ()
 
Objective getObjective (DisplaySlot slot) throws IllegalArgumentException
 
Set< ScoregetScores (OfflinePlayer player) throws IllegalArgumentException
 
Set< ScoregetScores (String entry) throws IllegalArgumentException
 
void resetScores (OfflinePlayer player) throws IllegalArgumentException
 
void resetScores (String entry) throws IllegalArgumentException
 
Team getPlayerTeam (OfflinePlayer player) throws IllegalArgumentException
 
Team getTeam (String teamName) throws IllegalArgumentException
 
Set< TeamgetTeams ()
 
Team registerNewTeam (String name) throws IllegalArgumentException
 
Set< OfflinePlayergetPlayers ()
 
Set< String > getEntries ()
 
void clearSlot (DisplaySlot slot) throws IllegalArgumentException
 

Detailed Description

A scoreboard

Definition at line 10 of file Scoreboard.java.

Member Function Documentation

void org.bukkit.scoreboard.Scoreboard.clearSlot ( DisplaySlot  slot) throws IllegalArgumentException

Clears any objective in the specified slot.

Parameters
slotthe slot to remove objectives
Exceptions
IllegalArgumentExceptionif slot is null
Set<String> org.bukkit.scoreboard.Scoreboard.getEntries ( )

Gets all entries tracked by this Scoreboard

Returns
immutable set of all tracked entries
Objective org.bukkit.scoreboard.Scoreboard.getObjective ( String  name) throws IllegalArgumentException

Gets an Objective on this Scoreboard by name

Parameters
nameName of the Objective
Returns
the Objective or null if it does not exist
Exceptions
IllegalArgumentExceptionif name is null
Objective org.bukkit.scoreboard.Scoreboard.getObjective ( DisplaySlot  slot) throws IllegalArgumentException

Gets the Objective currently displayed in a DisplaySlot on this Scoreboard

Parameters
slotThe DisplaySlot
Returns
the Objective currently displayed or null if nothing is displayed in that DisplaySlot
Exceptions
IllegalArgumentExceptionif slot is null
Set<Objective> org.bukkit.scoreboard.Scoreboard.getObjectives ( )

Gets all Objectives on this Scoreboard

Returns
An immutable set of all Objectives on this Scoreboard
Set<Objective> org.bukkit.scoreboard.Scoreboard.getObjectivesByCriteria ( String  criteria) throws IllegalArgumentException

Gets all Objectives of a Criteria on the Scoreboard

Parameters
criteriaCriteria to search by
Returns
an immutable set of Objectives using the specified Criteria
Set<OfflinePlayer> org.bukkit.scoreboard.Scoreboard.getPlayers ( )

Gets all players tracked by this Scoreboard

Returns
immutable set of all tracked players
Deprecated:
Scoreboards can contain entries that aren't players
See also
getEntries()
Team org.bukkit.scoreboard.Scoreboard.getPlayerTeam ( OfflinePlayer  player) throws IllegalArgumentException

Gets a player's Team on this Scoreboard

Parameters
playerthe player to search for
Returns
the player's Team or null if the player is not on a team
Exceptions
IllegalArgumentExceptionif player is null
Set<Score> org.bukkit.scoreboard.Scoreboard.getScores ( OfflinePlayer  player) throws IllegalArgumentException

Gets all scores for a player on this Scoreboard

Parameters
playerthe player whose scores are being retrieved
Returns
immutable set of all scores tracked for the player
Exceptions
IllegalArgumentExceptionif player is null
Deprecated:
Scoreboards can contain entries that aren't players
See also
getScores(String)
Set<Score> org.bukkit.scoreboard.Scoreboard.getScores ( String  entry) throws IllegalArgumentException

Gets all scores for an entry on this Scoreboard

Parameters
entrythe entry whose scores are being retrieved
Returns
immutable set of all scores tracked for the entry
Exceptions
IllegalArgumentExceptionif entry is null
Team org.bukkit.scoreboard.Scoreboard.getTeam ( String  teamName) throws IllegalArgumentException

Gets a Team by name on this Scoreboard

Parameters
teamNameTeam name
Returns
the matching Team or null if no matches
Exceptions
IllegalArgumentExceptionif teamName is null
Set<Team> org.bukkit.scoreboard.Scoreboard.getTeams ( )

Gets all teams on this Scoreboard

Returns
an immutable set of Teams
Objective org.bukkit.scoreboard.Scoreboard.registerNewObjective ( String  name,
String  criteria 
) throws IllegalArgumentException

Registers an Objective on this Scoreboard

Parameters
nameName of the Objective
criteriaCriteria for the Objective
Returns
The registered Objective
Exceptions
IllegalArgumentExceptionif name is null
IllegalArgumentExceptionif criteria is null
IllegalArgumentExceptionif an objective by that name already exists
Team org.bukkit.scoreboard.Scoreboard.registerNewTeam ( String  name) throws IllegalArgumentException

Registers a Team on this Scoreboard

Parameters
nameTeam name
Returns
registered Team
Exceptions
IllegalArgumentExceptionif name is null
IllegalArgumentExceptionif team by that name already exists
void org.bukkit.scoreboard.Scoreboard.resetScores ( OfflinePlayer  player) throws IllegalArgumentException

Removes all scores for a player on this Scoreboard

Parameters
playerthe player to drop all current scores for
Exceptions
IllegalArgumentExceptionif player is null
Deprecated:
Scoreboards can contain entries that aren't players
See also
resetScores(String)
void org.bukkit.scoreboard.Scoreboard.resetScores ( String  entry) throws IllegalArgumentException

Removes all scores for an entry on this Scoreboard

Parameters
entrythe entry to drop all current scores for
Exceptions
IllegalArgumentExceptionif entry is null

The documentation for this interface was generated from the following file: