blob: 50c6f762e077d12567c354d81a0e34fc41713565 (
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
|
package org.bukkit.scoreboard;
import java.util.Set;
import org.bukkit.OfflinePlayer;
import org.bukkit.potion.PotionEffectType;
/**
* A team on a scoreboard that has a common display theme and other
* properties. This team is only relevant to the display of the associated
* {@link #getScoreboard() scoreboard}.
*/
public interface Team {
/**
* Gets the name of this Team
*
* @return Objective name
* @throws IllegalStateException if this team has been unregistered
*/
String getName() throws IllegalStateException;
/**
* Gets the name displayed to players for this team
*
* @return Team display name
* @throws IllegalStateException if this team has been unregistered
*/
String getDisplayName() throws IllegalStateException;
/**
* Sets the name displayed to players for this team
*
* @param displayName New display name
* @throws IllegalArgumentException if displayName is longer than 32
* characters.
* @throws IllegalStateException if this team has been unregistered
*/
void setDisplayName(String displayName) throws IllegalStateException, IllegalArgumentException;
/**
* Gets the prefix prepended to the display of players on this team.
*
* @return Team prefix
* @throws IllegalStateException if this team has been unregistered
*/
String getPrefix() throws IllegalStateException;
/**
* Sets the prefix prepended to the display of players on this team.
*
* @param prefix New prefix
* @throws IllegalArgumentException if prefix is null
* @throws IllegalArgumentException if prefix is longer than 16
* characters
* @throws IllegalStateException if this team has been unregistered
*/
void setPrefix(String prefix) throws IllegalStateException, IllegalArgumentException;
/**
* Gets the suffix appended to the display of players on this team.
*
* @return the team's current suffix
* @throws IllegalStateException if this team has been unregistered
*/
String getSuffix() throws IllegalStateException;
/**
* Sets the suffix appended to the display of players on this team.
*
* @param suffix the new suffix for this team.
* @throws IllegalArgumentException if suffix is null
* @throws IllegalArgumentException if suffix is longer than 16
* characters
* @throws IllegalStateException if this team has been unregistered
*/
void setSuffix(String suffix) throws IllegalStateException, IllegalArgumentException;
/**
* Gets the team friendly fire state
*
* @return true if friendly fire is enabled
* @throws IllegalStateException if this team has been unregistered
*/
boolean allowFriendlyFire() throws IllegalStateException;
/**
* Sets the team friendly fire state
*
* @param enabled true if friendly fire is to be allowed
* @throws IllegalStateException if this team has been unregistered
*/
void setAllowFriendlyFire(boolean enabled) throws IllegalStateException;
/**
* Gets the team's ability to see {@link PotionEffectType#INVISIBILITY
* invisible} teammates.
*
* @return true if team members can see invisible members
* @throws IllegalStateException if this team has been unregistered
*/
boolean canSeeFriendlyInvisibles() throws IllegalStateException;
/**
* Sets the team's ability to see {@link PotionEffectType#INVISIBILITY
* invisible} teammates.
*
* @param enabled true if invisible teammates are to be visible
* @throws IllegalStateException if this team has been unregistered
*/
void setCanSeeFriendlyInvisibles(boolean enabled) throws IllegalStateException;
/**
* Gets the Set of players on the team
*
* @return players on the team
* @throws IllegalStateException if this team has been unregistered
*/
Set<OfflinePlayer> getPlayers() throws IllegalStateException;
/**
* Gets the size of the team
*
* @return number of players on the team
* @throws IllegalStateException if this team has been unregistered
*/
int getSize() throws IllegalStateException;
/**
* Gets the Scoreboard to which this team is attached
*
* @return Owning scoreboard, or null if this team has been {@link
* #unregister() unregistered}
*/
Scoreboard getScoreboard();
/**
* This puts the specified player onto this team for the scoreboard.
* <p>
* This will remove the player from any other team on the scoreboard.
*
* @param player the player to add
* @throws IllegalArgumentException if player is null
* @throws IllegalStateException if this team has been unregistered
*/
void addPlayer(OfflinePlayer player) throws IllegalStateException, IllegalArgumentException;
/**
* Removes the player from this team.
*
* @param player the player to remove
* @return if the player was on this team
* @throws IllegalArgumentException if player is null
* @throws IllegalStateException if this team has been unregistered
*/
boolean removePlayer(OfflinePlayer player) throws IllegalStateException, IllegalArgumentException;
/**
* Unregisters this team from the Scoreboard
*
* @throws IllegalStateException if this team has been unregistered
*/
void unregister() throws IllegalStateException;
/**
* Checks to see if the specified player is a member of this team.
*
* @param player the player to search for
* @return true if the player is a member of this team
* @throws IllegalArgumentException if player is null
* @throws IllegalStateException if this team has been unregistered
*/
boolean hasPlayer(OfflinePlayer player) throws IllegalArgumentException, IllegalStateException;
}
|
