team.unnamed.creative.sound

Interface Sound

All Superinterfaces:

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

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

Represents a Minecraft sound data in the resource-pack, similar to Texture.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this sound to the given resource container.
@NotNull Writable	data() Returns the sound's OGG sound data, as a Writable object, never null
@NotNull net.kyori.adventure.key.Key	key() Returns this sound's key (location), the key contains the sound namespace and path, so that the full sound path is formatted like assets/<namespace>/sounds/<path>
static @NotNull Sound	of(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data) Deprecated. Use sound(Key, Writable) instead
static @NotNull Sound	sound(@NotNull net.kyori.adventure.key.Key key, @NotNull Writable data) Creates a new sound instance with the given key and data.

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

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

sound

@NotNull
static @NotNull Sound sound(@NotNull
                                      @NotNull net.kyori.adventure.key.Key key,
                                      @NotNull
                                      @NotNull Writable data)

Creates a new sound instance with the given key and data.

Parameters:

key - The sound key

data - The sound data

Returns:

The sound instance

Since:

1.1.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Sound of(@NotNull
                                                                                                     @NotNull net.kyori.adventure.key.Key key,
                                                                                                     @NotNull
                                                                                                     @NotNull Writable data)

Deprecated. Use sound(Key, Writable) instead

Creates a new sound instance with the given key and data.

Parameters:

key - The sound key

data - The sound data

Returns:

The sound instance

Since:

1.0.0

key

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

Returns this sound's key (location), the key contains the sound namespace and path, so that the full sound path is formatted like assets/<namespace>/sounds/<path>

Example key for a sound:

   Key key = Key.key("minecraft", "ambient/cave");
 

Note that the key value must not include the sound extension

Specified by:

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

Returns:

The sound key

data

@NotNull
@NotNull Writable data()

Returns the sound's OGG sound data, as a Writable object, never null

Returns:

The OGG sound data

Since:

1.0.0

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this sound to the given resource container.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0