-
-
Notifications
You must be signed in to change notification settings - Fork 100
/
Sound.java
258 lines (240 loc) · 6.56 KB
/
Sound.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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/*
* 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.key.Key;
import net.kyori.adventure.key.Keyed;
import net.kyori.adventure.util.Index;
import net.kyori.examination.Examinable;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import static java.util.Objects.requireNonNull;
/**
* Represents an in-game sound which can be played to the client.
*
* <p>A sound consists of:</p>
* <dl>
* <dt>key/type</dt>
* <dd>the resource location of this sound (e.g minecraft:ambient.cave or my_plugin:custom_sound</dd>
* <dt>source</dt>
* <dd>a {@link Source} telling the game where the sound is coming from</dd>
* <dt>volume</dt>
* <dd>a number in the range [0,∞) representing how loud the sound should be played.
* Increasing volume does not actually play the sound louder, but increases the radius
* of where it can be heard</dd>
* <dt>pitch</dt>
* <dd>a number in the range [0,2] representing which pitch the sound should be played at</dd>
* </dl>
*
* @see SoundStop
* @since 4.0.0
*/
@ApiStatus.NonExtendable
public interface Sound extends Examinable {
/**
* Creates a new sound.
*
* @param name the name
* @param source the source
* @param volume the volume
* @param pitch the pitch
* @return the sound
* @since 4.0.0
*/
static @NotNull Sound sound(final @NotNull Key name, final @NotNull Source source, final float volume, final float pitch) {
requireNonNull(name, "name");
requireNonNull(source, "source");
return new SoundImpl(source, volume, pitch) {
@Override
public @NotNull Key name() {
return name;
}
};
}
/**
* Creates a new sound.
*
* @param type the type
* @param source the source
* @param volume the volume
* @param pitch the pitch
* @return the sound
* @since 4.0.0
*/
static @NotNull Sound sound(final @NotNull Type type, final @NotNull Source source, final float volume, final float pitch) {
requireNonNull(type, "type");
return sound(type.key(), source, volume, pitch);
}
/**
* Creates a new sound.
*
* @param type the type
* @param source the source
* @param volume the volume
* @param pitch the pitch
* @return the sound
* @since 4.0.0
*/
static @NotNull Sound sound(final @NotNull Supplier<? extends Type> type, final @NotNull Source source, final float volume, final float pitch) {
requireNonNull(type, "type");
requireNonNull(source, "source");
return new SoundImpl(source, volume, pitch) {
@Override
public @NotNull Key name() {
return type.get().key();
}
};
}
/**
* Creates a new sound.
*
* @param name the name
* @param source the source
* @param volume the volume
* @param pitch the pitch
* @return the sound
* @since 4.8.0
*/
static @NotNull Sound sound(final @NotNull Key name, final Source.@NotNull Provider source, final float volume, final float pitch) {
return sound(name, source.soundSource(), volume, pitch);
}
/**
* Creates a new sound.
*
* @param type the type
* @param source the source
* @param volume the volume
* @param pitch the pitch
* @return the sound
* @since 4.8.0
*/
static @NotNull Sound sound(final @NotNull Type type, final Source.@NotNull Provider source, final float volume, final float pitch) {
return sound(type, source.soundSource(), volume, pitch);
}
/**
* Creates a new sound.
*
* @param type the type
* @param source the source
* @param volume the volume
* @param pitch the pitch
* @return the sound
* @since 4.8.0
*/
static @NotNull Sound sound(final @NotNull Supplier<? extends Type> type, final Source.@NotNull Provider source, final float volume, final float pitch) {
return sound(type, source.soundSource(), volume, pitch);
}
/**
* Gets the name.
*
* @return the name
* @since 4.0.0
*/
@NotNull Key name();
/**
* Gets the source.
*
* @return the source
* @since 4.0.0
*/
@NotNull Source source();
/**
* Gets the volume.
*
* @return the volume
* @since 4.0.0
*/
float volume();
/**
* Gets the pitch.
*
* @return the pitch
* @since 4.0.0
*/
float pitch();
/**
* The sound source.
*
* @since 4.0.0
*/
enum Source {
MASTER("master"),
MUSIC("music"),
RECORD("record"),
WEATHER("weather"),
BLOCK("block"),
HOSTILE("hostile"),
NEUTRAL("neutral"),
PLAYER("player"),
AMBIENT("ambient"),
VOICE("voice");
/**
* The name map.
*
* @since 4.0.0
*/
public static final Index<String, Source> NAMES = Index.create(Source.class, source -> source.name);
private final String name;
Source(final String name) {
this.name = name;
}
/**
* A provider of sound sources.
*
* @since 4.8.0
*/
public interface Provider {
/**
* Gets the source.
*
* @return the source
* @since 4.8.0
*/
@NotNull Source soundSource();
}
}
/**
* A sound type.
*
* @since 4.0.0
*/
interface Type extends Keyed {
/**
* Gets the key.
*
* @return the key
* @since 4.0.0
*/
@Override
@NotNull Key key();
}
/**
* An emitter of sounds.
*
* @see net.kyori.adventure.audience.Audience#playSound(Sound, Emitter)
* @since 4.8.0
*/
interface Emitter {
}
}