team.unnamed.creative.sound

Interface SoundEntry.Builder

Enclosing interface:

SoundEntry

public static interface SoundEntry.Builder

Mutable and fluent-style builder for SoundEntry instances, since it has a lot of parameters, we create a builder for ease its creation

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
@NotNull SoundEntry.Builder	attenuationDistance(int attenuationDistance) Sets the attenuation distance for the sound.
@NotNull SoundEntry	build() Finishes building the SoundEntry instance, this method may fail if values were not correctly provided.
@NotNull SoundEntry.Builder	key(@NotNull net.kyori.adventure.key.Key key) Sets the sound key for the sound entry.
default @NotNull SoundEntry.Builder	nameEvent(@NotNull net.kyori.adventure.key.Key key) Deprecated. Set type(team.unnamed.creative.sound.SoundEntry.Type) and key(net.kyori.adventure.key.Key) separately instead
default @NotNull SoundEntry.Builder	nameEvent(@NotNull java.lang.String name) Deprecated. Set type(team.unnamed.creative.sound.SoundEntry.Type) and key(net.kyori.adventure.key.Key) separately instead
default @NotNull SoundEntry.Builder	nameSound(@NotNull net.kyori.adventure.key.Key key) Deprecated. Set type(team.unnamed.creative.sound.SoundEntry.Type) and key(net.kyori.adventure.key.Key) separately instead
@NotNull SoundEntry.Builder	pitch(float pitch) Sets the pitch for the sound.
@NotNull SoundEntry.Builder	preload(boolean preload) Sets the preload value for the sound.
@NotNull SoundEntry.Builder	stream(boolean stream) Sets whether the sound should be streamed.
@NotNull SoundEntry.Builder	type(@NotNull SoundEntry.Type type) Sets the sound type for the sound entry.
@NotNull SoundEntry.Builder	volume(float volume) Sets the volume for the sound.
@NotNull SoundEntry.Builder	weight(int weight) Sets the weight for the sound.

Method Detail

type

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEntry.Builder type(@NotNull
                                                                          @NotNull SoundEntry.Type type)

Sets the sound type for the sound entry.

If type is SoundEntry.Type.EVENT, the set key must be a SoundEvent key.

If type is SoundEntry.Type.FILE, the set key must be a Sound key.

Parameters:

type - The sound type

Returns:

This builder

Since:

1.0.0

key

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEntry.Builder key(@NotNull
                                                                         @NotNull net.kyori.adventure.key.Key key)

Sets the sound key for the sound entry.

Parameters:

key - The sound key

Returns:

This builder

Since:

1.0.0

nameSound

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Contract(value="_ -> this")
 @NotNull
default @NotNull SoundEntry.Builder nameSound(@NotNull
                                                                                                                                                         @NotNull net.kyori.adventure.key.Key key)

Deprecated. Set type(team.unnamed.creative.sound.SoundEntry.Type) and key(net.kyori.adventure.key.Key) separately instead

Sets the Sound key for the sound entry.

Parameters:

key - The sound key

Returns:

This builder

Since:

1.0.0

nameEvent

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Contract(value="_ -> this")
 @NotNull
default @NotNull SoundEntry.Builder nameEvent(@NotNull
                                                                                                                                                         @NotNull net.kyori.adventure.key.Key key)

Deprecated. Set type(team.unnamed.creative.sound.SoundEntry.Type) and key(net.kyori.adventure.key.Key) separately instead

Sets the SoundEvent key for the sound entry.

Parameters:

key - The sound event key

Returns:

This builder

Since:

1.0.0

nameEvent

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @Contract(value="_ -> this")
 @NotNull
default @NotNull SoundEntry.Builder nameEvent(@NotNull
                                                                                                                                                         @NotNull java.lang.String name)

Deprecated. Set type(team.unnamed.creative.sound.SoundEntry.Type) and key(net.kyori.adventure.key.Key) separately instead

Sets the SoundEvent name for the sound entry.

Parameters:

name - The sound event name

Returns:

This builder

Since:

1.0.0

volume

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEntry.Builder volume(float volume)

Sets the volume for the sound.

Parameters:

volume - The sound volume

Returns:

This builder

Since:

1.0.0

pitch

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEntry.Builder pitch(float pitch)

Sets the pitch for the sound.

Parameters:

pitch - The sound pitch

Returns:

This builder

Since:

1.0.0

weight

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEntry.Builder weight(int weight)

Sets the weight for the sound.

Parameters:

weight - The sound weight

Returns:

This builder

Since:

1.0.0

stream

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEntry.Builder stream(boolean stream)

Sets whether the sound should be streamed.

Parameters:

stream - True if the sound should be streamed

Returns:

This builder

Since:

1.0.0

attenuationDistance

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEntry.Builder attenuationDistance(int attenuationDistance)

Sets the attenuation distance for the sound.

Parameters:

attenuationDistance - The attenuation distance

Returns:

This builder

Since:

1.0.0

preload

@Contract(value="_ -> this")
 @NotNull
@NotNull SoundEntry.Builder preload(boolean preload)

Sets the preload value for the sound.

Parameters:

preload - True if the sound should be preloaded

Returns:

This builder

Since:

1.0.0

build

@NotNull
@NotNull SoundEntry build()

Finishes building the SoundEntry instance, this method may fail if values were not correctly provided.

Returns:

The recently created sound

Since:

1.0.0