blob: 40f36b47a165e023501eb4c1fe227e89bd4b83be (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
package org.bukkit.scoreboard;
import java.util.Set;
import org.bukkit.OfflinePlayer;
/**
* A scoreboard
*/
public interface Scoreboard {
/**
* Registers an Objective on this Scoreboard
*
* @param name Name of the Objective
* @param criteria Criteria for the Objective
* @return The registered Objective
* @throws IllegalArgumentException if name is null
* @throws IllegalArgumentException if name is longer than 16
* characters.
* @throws IllegalArgumentException if criteria is null
* @throws IllegalArgumentException if an objective by that name already
* exists
* @deprecated a displayName should be explicitly specified
*/
@Deprecated
Objective registerNewObjective(String name, String criteria) throws IllegalArgumentException;
/**
* Registers an Objective on this Scoreboard
*
* @param name Name of the Objective
* @param criteria Criteria for the Objective
* @param displayName Name displayed to players for the Objective.
* @return The registered Objective
* @throws IllegalArgumentException if name is null
* @throws IllegalArgumentException if name is longer than 16
* characters.
* @throws IllegalArgumentException if criteria is null
* @throws IllegalArgumentException if displayName is null
* @throws IllegalArgumentException if displayName is longer than 128
* characters.
* @throws IllegalArgumentException if an objective by that name already
* exists
*/
Objective registerNewObjective(String name, String criteria, String displayName) throws IllegalArgumentException;
/**
* Gets an Objective on this Scoreboard by name
*
* @param name Name of the Objective
* @return the Objective or null if it does not exist
* @throws IllegalArgumentException if name is null
*/
Objective getObjective(String name) throws IllegalArgumentException;
/**
* Gets all Objectives of a Criteria on the Scoreboard
*
* @param criteria Criteria to search by
* @return an immutable set of Objectives using the specified Criteria
*/
Set<Objective> getObjectivesByCriteria(String criteria) throws IllegalArgumentException;
/**
* Gets all Objectives on this Scoreboard
*
* @return An immutable set of all Objectives on this Scoreboard
*/
Set<Objective> getObjectives();
/**
* Gets the Objective currently displayed in a DisplaySlot on this
* Scoreboard
*
* @param slot The DisplaySlot
* @return the Objective currently displayed or null if nothing is
* displayed in that DisplaySlot
* @throws IllegalArgumentException if slot is null
*/
Objective getObjective(DisplaySlot slot) throws IllegalArgumentException;
/**
* Gets all scores for a player on this Scoreboard
*
* @param player the player whose scores are being retrieved
* @return immutable set of all scores tracked for the player
* @throws IllegalArgumentException if player is null
* @deprecated Scoreboards can contain entries that aren't players
* @see #getScores(String)
*/
@Deprecated
Set<Score> getScores(OfflinePlayer player) throws IllegalArgumentException;
/**
* Gets all scores for an entry on this Scoreboard
*
* @param entry the entry whose scores are being retrieved
* @return immutable set of all scores tracked for the entry
* @throws IllegalArgumentException if entry is null
*/
Set<Score> getScores(String entry) throws IllegalArgumentException;
/**
* Removes all scores for a player on this Scoreboard
*
* @param player the player to drop all current scores for
* @throws IllegalArgumentException if player is null
* @deprecated Scoreboards can contain entries that aren't players
* @see #resetScores(String)
*/
@Deprecated
void resetScores(OfflinePlayer player) throws IllegalArgumentException;
/**
* Removes all scores for an entry on this Scoreboard
*
* @param entry the entry to drop all current scores for
* @throws IllegalArgumentException if entry is null
*/
void resetScores(String entry) throws IllegalArgumentException;
/**
* Gets a player's Team on this Scoreboard
*
* @param player the player to search for
* @return the player's Team or null if the player is not on a team
* @throws IllegalArgumentException if player is null
* @deprecated Scoreboards can contain entries that aren't players
* @see #getEntryTeam(String)
*/
@Deprecated
Team getPlayerTeam(OfflinePlayer player) throws IllegalArgumentException;
/**
* Gets a entries Team on this Scoreboard
*
* @param entry the entry to search for
* @return the entries Team or null if the entry is not on a team
* @throws IllegalArgumentException if entry is null
*/
Team getEntryTeam(String entry) throws IllegalArgumentException;
/**
* Gets a Team by name on this Scoreboard
*
* @param teamName Team name
* @return the matching Team or null if no matches
* @throws IllegalArgumentException if teamName is null
*/
Team getTeam(String teamName) throws IllegalArgumentException;
/**
* Gets all teams on this Scoreboard
*
* @return an immutable set of Teams
*/
Set<Team> getTeams();
/**
* Registers a Team on this Scoreboard
*
* @param name Team name
* @return registered Team
* @throws IllegalArgumentException if name is null
* @throws IllegalArgumentException if team by that name already exists
*/
Team registerNewTeam(String name) throws IllegalArgumentException;
/**
* Gets all players tracked by this Scoreboard
*
* @return immutable set of all tracked players
* @deprecated Scoreboards can contain entries that aren't players
* @see #getEntries()
*/
@Deprecated
Set<OfflinePlayer> getPlayers();
/**
* Gets all entries tracked by this Scoreboard
*
* @return immutable set of all tracked entries
*/
Set<String> getEntries();
/**
* Clears any objective in the specified slot.
*
* @param slot the slot to remove objectives
* @throws IllegalArgumentException if slot is null
*/
void clearSlot(DisplaySlot slot) throws IllegalArgumentException;
}
|
