team.unnamed.creative.sound

Interface SoundEntry

All Superinterfaces:

net.kyori.examination.Examinable, net.kyori.adventure.key.Keyed

@ApiStatus.NonExtendable
public interface SoundEntry
extends net.kyori.adventure.key.Keyed, net.kyori.examination.Examinable

Represents a possible sound for a SoundEvent, when a sound event is called, a random sound is selected to be played

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
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
static class	SoundEntry.Type Specifies the type of SoundEntry

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ATTENUATION_DISTANCE
static float	DEFAULT_PITCH
static boolean	DEFAULT_PRELOAD
static boolean	DEFAULT_STREAM
static SoundEntry.Type	DEFAULT_TYPE
static float	DEFAULT_VOLUME
static int	DEFAULT_WEIGHT

Method Summary

Modifier and Type	Method and Description
boolean	allDefault() Determines if the sound has all its properties with the default values
int	attenuationDistance() Returns the attenuation distance, which modifies the sound reduction rate based on distance
static @NotNull SoundEntry.Builder	builder() Deprecated. Use soundEntry() instead
static @NotNull SoundEntry	event(@NotNull net.kyori.adventure.key.Key name, float volume, float pitch, int weight, boolean stream, int attenuationDistance, boolean preload) Deprecated. Use the builder instead
static SoundEntry	event(@NotNull java.lang.String name, float volume, float pitch, int weight, boolean stream, int attenuationDistance, boolean preload) Deprecated. Use the builder instead
@NotNull net.kyori.adventure.key.Key	key() Returns the path to this sound file, starting from assets/<namespace>/sounds folder or another sound event key
default @NotNull java.lang.String	name() Deprecated. Use key() instead
float	pitch() Returns the sound pitch, can be higher or lower than zero or one
boolean	preload() Determines whether this sound should be loaded when loading the pack instead of when the sound is played
static @NotNull SoundEntry	sound(@NotNull net.kyori.adventure.key.Key path, float volume, float pitch, int weight, boolean stream, int attenuationDistance, boolean preload) Deprecated. Use the builder instead
static @NotNull SoundEntry.Builder	soundEntry() Static factory method for our builder implementation
static @NotNull SoundEntry	soundEntry(@NotNull Sound sound) Creates a new SoundEntry from the given sound.
static @NotNull SoundEntry	soundEntry(@NotNull SoundEvent soundEvent) Creates a new SoundEntry from the given sound event.
boolean	stream() Returns true if this sound should be streamed from its file.
@NotNull SoundEntry.Builder	toBuilder() Converts this sound entry instance to its builder type, with all the properties already set
@NotNull SoundEntry.Type	type() Returns the sound type, which determines how to interpret the name() property
float	volume() Returns the volume for playing this sound.
int	weight() Returns the chance that this sound is selected to play when this sound event is triggered
static @NotNull SoundEntry	withDefaultValues(@NotNull Sound sound) Deprecated. Use soundEntry(Sound) instead

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

DEFAULT_VOLUME

static final float DEFAULT_VOLUME

See Also:

Constant Field Values

DEFAULT_PITCH

static final float DEFAULT_PITCH

See Also:

Constant Field Values

DEFAULT_WEIGHT

static final int DEFAULT_WEIGHT

See Also:

Constant Field Values

DEFAULT_STREAM

static final boolean DEFAULT_STREAM

See Also:

Constant Field Values

DEFAULT_ATTENUATION_DISTANCE

static final int DEFAULT_ATTENUATION_DISTANCE

See Also:

Constant Field Values

DEFAULT_PRELOAD

static final boolean DEFAULT_PRELOAD

See Also:

Constant Field Values

DEFAULT_TYPE

static final SoundEntry.Type DEFAULT_TYPE

Method Detail

sound

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull SoundEntry sound(@NotNull
                                                                                                             @NotNull net.kyori.adventure.key.Key path,
                                                                                                             float volume,
                                                                                                             float pitch,
                                                                                                             int weight,
                                                                                                             boolean stream,
                                                                                                             int attenuationDistance,
                                                                                                             boolean preload)

Deprecated. Use the builder instead

Creates a new SoundEntry from the given properties, using SoundEntry.Type.FILE as sound type

Parameters:

path - The sound file path

volume - The sound volume (0-1)

pitch - The sound pitch

weight - The sound weight

stream - True if the sound should be streamed

attenuationDistance - The sound attenuation distance

preload - True if the sound should be preloaded

Returns:

A new sound

Since:

1.0.0

soundEntry

@NotNull
static @NotNull SoundEntry soundEntry(@NotNull
                                                @NotNull Sound sound)

Creates a new SoundEntry from the given sound.

Parameters:

sound - The sound

Returns:

A new sound entry

Since:

1.1.0

soundEntry

@NotNull
static @NotNull SoundEntry soundEntry(@NotNull
                                                @NotNull SoundEvent soundEvent)

Creates a new SoundEntry from the given sound event.

Parameters:

soundEvent - The sound event

Returns:

A new sound entry

Since:

1.1.0

withDefaultValues

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull SoundEntry withDefaultValues(@NotNull
                                                                                                                         @NotNull Sound sound)

Deprecated. Use soundEntry(Sound) instead

Creates a new SoundEntry from the given sound.

Parameters:

sound - The sound

Returns:

A new sound entry

Since:

1.0.0

event

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull SoundEntry event(@NotNull
                                                                                                             @NotNull net.kyori.adventure.key.Key name,
                                                                                                             float volume,
                                                                                                             float pitch,
                                                                                                             int weight,
                                                                                                             boolean stream,
                                                                                                             int attenuationDistance,
                                                                                                             boolean preload)

Deprecated. Use the builder instead

Creates a new SoundEntry from the given properties, using SoundEntry.Type.EVENT as sound type

Parameters:

name - The sound event name

volume - The sound volume (0-1)

pitch - The sound pitch

weight - The sound weight

stream - True if the sound should be streamed

attenuationDistance - The sound attenuation distance

preload - True if the sound should be preloaded

Returns:

A new sound

Since:

1.0.0

event

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
static SoundEntry event(@NotNull
                                                                                         @NotNull java.lang.String name,
                                                                                         float volume,
                                                                                         float pitch,
                                                                                         int weight,
                                                                                         boolean stream,
                                                                                         int attenuationDistance,
                                                                                         boolean preload)

Deprecated. Use the builder instead

Creates a new SoundEntry from the given properties, using SoundEntry.Type.EVENT as sound type

Parameters:

name - The sound event name

volume - The sound volume (0-1)

pitch - The sound pitch

weight - The sound weight

stream - True if the sound should be streamed

attenuationDistance - The sound attenuation distance

preload - True if the sound should be preloaded

Returns:

A new sound

Since:

1.0.0

soundEntry

@NotNull
static @NotNull SoundEntry.Builder soundEntry()

Static factory method for our builder implementation

Returns:

A new builder for SoundEntry instances

Since:

1.1.0

builder

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull SoundEntry.Builder builder()

Deprecated. Use soundEntry() instead

Static factory method for our builder implementation

Returns:

A new builder for SoundEntry instances

Since:

1.0.0

key

@NotNull
@NotNull net.kyori.adventure.key.Key key()

Returns the path to this sound file, starting from assets/<namespace>/sounds folder or another sound event key

If type is FILE, the returned key is a Sound key

Doesn't include the file extension (.ogg)

May instead be the key of another sound event, according to value of type

Specified by:

key in interface net.kyori.adventure.key.Keyed

Returns:

The sound path or sound event key

Since:

1.0.0

name

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
default @NotNull java.lang.String name()

Deprecated. Use key() instead

Returns:

The sound entry's name (Key.value())

volume

float volume()

Returns the volume for playing this sound. Value is a decimal between zero and one

Returns:

The sound volume

Since:

1.0.0

pitch

float pitch()

Returns the sound pitch, can be higher or lower than zero or one

Returns:

The sound pitch

Since:

1.0.0

weight

int weight()

Returns the chance that this sound is selected to play when this sound event is triggered

An example: putting 2 in for the value would be like placing in the name twice

Returns:

The sound weight

Since:

1.0.0

stream

boolean stream()

Returns true if this sound should be streamed from its file. It is recommended that this is set to "true" for sounds that have a duration longer than a few seconds to avoid lag

It is used for all sounds in the "music" and "record" categories (except Note Block sounds), as (almost) all the sounds that belong to those categories are over a minute- long

Setting this to false allows many more instances of the sound to be run at the same time while setting it to true only allows 4 instances (of that type) to be run at the same time

Returns:

True if this sound is streamed from its file

Since:

1.0.0

attenuationDistance

int attenuationDistance()

Returns the attenuation distance, which modifies the sound reduction rate based on distance

It is used by portals, beacons, and conduits

Returns:

The sound attenuation distance

Since:

1.0.0

preload

boolean preload()

Determines whether this sound should be loaded when loading the pack instead of when the sound is played

It is used by the underwater ambience

Returns:

True to preload

Since:

1.0.0

type

@NotNull
@NotNull SoundEntry.Type type()

Returns the sound type, which determines how to interpret the name() property

Returns:

The sound type

Since:

1.0.0

allDefault

boolean allDefault()

Determines if the sound has all its properties with the default values

Returns:

True if all the properties are default

Since:

1.0.0

toBuilder

@Contract(value="-> new")
 @NotNull
@NotNull SoundEntry.Builder toBuilder()

Converts this sound entry instance to its builder type, with all the properties already set

Returns:

The created builder

Since:

1.6.0