team.unnamed.creative.sound

Interface SoundEvent

All Superinterfaces:

net.kyori.examination.Examinable, net.kyori.adventure.key.Keyed, ResourcePackPart, net.kyori.adventure.sound.Sound.Type

@ApiStatus.NonExtendable
public interface SoundEvent
extends ResourcePackPart, net.kyori.adventure.sound.Sound.Type, net.kyori.examination.Examinable

Represents a sound event, a compound of SoundEntry instances

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SoundEvent.Builder Builder implementation for ease the construction of SoundEvent instances

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_REPLACE

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this sound event to the given resource container.
static @NotNull SoundEvent.Builder	builder() Deprecated. Use soundEvent() instead
@NotNull net.kyori.adventure.key.Key	key() Returns this sound event's key.
static @NotNull SoundEvent	of(@NotNull net.kyori.adventure.key.Key key, boolean replace, @Nullable java.lang.String subtitle, @NotNull java.util.List<SoundEntry> sounds) Deprecated. Use soundEvent(Key, boolean, String, List) instead
boolean	replace() Returns true if the sounds listed in sounds() should replace the sounds listed in the default sounds.json for this sound event.
static @NotNull SoundEvent.Builder	soundEvent() Creates a new SoundEvent.Builder instance, it eases the creation of SoundEvent objects
static @NotNull SoundEvent	soundEvent(@NotNull net.kyori.adventure.key.Key key, boolean replace, @Nullable java.lang.String subtitle, @NotNull java.util.List<SoundEntry> sounds) Creates a new SoundEvent from the given values
@Unmodifiable @NotNull java.util.List<SoundEntry>	sounds() The sounds this sound event uses, one of the listed sounds is randomly selected to play when this sound event is triggered
@Nullable java.lang.String	subtitle() Returns the sound event subtitle, which is translated as the subtitle of the sound if "Show Subtitles" is enabled in-game
@NotNull SoundEvent.Builder	toBuilder() Converts this sound event instance to its builder type, with all the properties already set

Methods inherited from interface team.unnamed.creative.part.ResourcePackPart

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Field Detail

DEFAULT_REPLACE

static final boolean DEFAULT_REPLACE

See Also:

Constant Field Values

Method Detail

soundEvent

@NotNull
static @NotNull SoundEvent soundEvent(@NotNull
                                                @NotNull net.kyori.adventure.key.Key key,
                                                boolean replace,
                                                @Nullable
                                                @Nullable java.lang.String subtitle,
                                                @NotNull
                                                @NotNull java.util.List<SoundEntry> sounds)

Creates a new SoundEvent from the given values

Parameters:

key - The sound event's key

replace - True to replace default sounds

subtitle - The sound event subtitle

sounds - The sound event sounds

Returns:

A new SoundEvent instance

Since:

1.1.0

soundEvent

@NotNull
static @NotNull SoundEvent.Builder soundEvent()

Creates a new SoundEvent.Builder instance, it eases the creation of SoundEvent objects

Returns:

A new SoundEvent.Builder instance

Since:

1.1.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull SoundEvent of(@NotNull
                                                                                                          @NotNull net.kyori.adventure.key.Key key,
                                                                                                          boolean replace,
                                                                                                          @Nullable
                                                                                                          @Nullable java.lang.String subtitle,
                                                                                                          @NotNull
                                                                                                          @NotNull java.util.List<SoundEntry> sounds)

Deprecated. Use soundEvent(Key, boolean, String, List) instead

Creates a new SoundEvent from the given values

Parameters:

key - The sound event's key

replace - True to replace default sounds

subtitle - The sound event subtitle

sounds - The sound event sounds

Returns:

A new SoundEvent instance

Since:

1.0.0

builder

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

Deprecated. Use soundEvent() instead

Creates a new SoundEvent.Builder instance, it eases the creation of SoundEvent objects

Returns:

A new SoundEvent.Builder instance

Since:

1.0.0

key

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

Returns this sound event's key.

Specified by:

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

Specified by:

key in interface net.kyori.adventure.sound.Sound.Type

Returns:

The sound event's key

Since:

1.0.0

replace

boolean replace()

Returns true if the sounds listed in sounds() should replace the sounds listed in the default sounds.json for this sound event. False if the sounds listed should be added to the list of default sounds

Returns:

True to replace default sounds.json sounds

Since:

1.0.0

subtitle

@Nullable
@Nullable java.lang.String subtitle()

Returns the sound event subtitle, which is translated as the subtitle of the sound if "Show Subtitles" is enabled in-game

Returns:

The sound subtitle

Since:

1.0.0

sounds

@NotNull
@Unmodifiable @NotNull java.util.List<SoundEntry> sounds()

The sounds this sound event uses, one of the listed sounds is randomly selected to play when this sound event is triggered

Returns:

An unmodifiable list of the sound that this event uses

Since:

1.0.0

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this sound event to the given resource container.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0

toBuilder

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

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

Returns:

The created builder

Since:

1.6.0