-
-
Notifications
You must be signed in to change notification settings - Fork 102
/
SoundStop.java
205 lines (192 loc) · 5.61 KB
/
SoundStop.java
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
195
196
197
198
199
200
201
202
203
204
205
/*
* This file is part of adventure, licensed under the MIT License.
*
* Copyright (c) 2017-2021 KyoriPowered
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.kyori.adventure.sound;
import java.util.function.Supplier;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.key.Key;
import net.kyori.examination.Examinable;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import static java.util.Objects.requireNonNull;
/**
* A sound and/or a sound source, used for stopping in-game sounds that
* are being played on a game client matching the given sound and/or sound source.
*
* <p>For clarification: a {@link SoundStop} consisting of the sound "ambient.weather.rain" and the source {@link Sound.Source#AMBIENT}
* will only stop sounds matching BOTH parameters and not sounds matching only the sound or only the source.</p>
*
*
* @see Audience#stopSound(SoundStop)
* @since 4.0.0
*/
@ApiStatus.NonExtendable
public interface SoundStop extends Examinable {
/**
* Stops all sounds.
*
* @return a sound stopper
* @since 4.0.0
*/
static @NotNull SoundStop all() {
return SoundStopImpl.ALL;
}
/**
* Stops all sounds named {@code sound}.
*
* @param sound the sound
* @return a sound stopper
* @since 4.0.0
*/
static @NotNull SoundStop named(final @NotNull Key sound) {
requireNonNull(sound, "sound");
return new SoundStopImpl(null) {
@Override
public @NotNull Key sound() {
return sound;
}
};
}
/**
* Stops all sounds named {@code sound}.
*
* @param sound the sound
* @return a sound stopper
* @since 4.0.0
*/
static @NotNull SoundStop named(final Sound.@NotNull Type sound) {
requireNonNull(sound, "sound");
return new SoundStopImpl(null) {
@Override
public @NotNull Key sound() {
return sound.key();
}
};
}
/**
* Stops all sounds named {@code sound}.
*
* @param sound the sound
* @return a sound stopper
* @since 4.0.0
*/
static @NotNull SoundStop named(final @NotNull Supplier<? extends Sound.Type> sound) {
requireNonNull(sound, "sound");
return new SoundStopImpl(null) {
@Override
public @NotNull Key sound() {
return sound.get().key();
}
};
}
/**
* Stops all sounds on source {@code source}.
*
* @param source the source
* @return a sound stopper
* @since 4.0.0
*/
static @NotNull SoundStop source(final Sound.@NotNull Source source) {
requireNonNull(source, "source");
return new SoundStopImpl(source) {
@Override
public @Nullable Key sound() {
return null;
}
};
}
/**
* Stops all sounds named {@code name} on source {@code source}.
*
* @param sound the sound
* @param source the source
* @return a sound stopper
* @since 4.0.0
*/
static @NotNull SoundStop namedOnSource(final @NotNull Key sound, final Sound.@NotNull Source source) {
requireNonNull(sound, "sound");
requireNonNull(source, "source");
return new SoundStopImpl(source) {
@Override
public @NotNull Key sound() {
return sound;
}
};
}
/**
* Stops all sounds named {@code name} on source {@code source}.
*
* @param sound the sound
* @param source the source
* @return a sound stopper
* @since 4.0.0
*/
static @NotNull SoundStop namedOnSource(final Sound.@NotNull Type sound, final Sound.@NotNull Source source) {
requireNonNull(sound, "sound");
return namedOnSource(sound.key(), source);
}
/**
* Stops all sounds named {@code name} on source {@code source}.
*
* @param sound the sound
* @param source the source
* @return a sound stopper
* @since 4.0.0
*/
static @NotNull SoundStop namedOnSource(final @NotNull Supplier<? extends Sound.Type> sound, final Sound.@NotNull Source source) {
requireNonNull(sound, "sound");
requireNonNull(source, "source");
return new SoundStopImpl(source) {
@Override
public @NotNull Key sound() {
return sound.get().key();
}
};
}
/**
* Stops a specific sound.
*
* @param sound the sound
* @return a sound stopper
* @since 4.8.0
*/
static @NotNull SoundStop sound(final @NotNull Sound sound) {
requireNonNull(sound, "sound");
return namedOnSource(sound.name(), sound.source());
}
/**
* Gets the sound.
*
* @return the sound
* @since 4.0.0
*/
@Nullable Key sound();
/**
* Gets the source.
*
* @return the source
* @since 4.0.0
*/
Sound.@Nullable Source source();
}