team.unnamed.creative.sound

Interface SoundRegistry

All Superinterfaces:

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

public interface SoundRegistry
extends ResourcePackPart, net.kyori.adventure.key.Namespaced, net.kyori.examination.Examinable

Represents a SoundEvent registry.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SoundRegistry.Builder A sound registry builder.

Method Summary

Modifier and Type	Method and Description
default void	addTo(@NotNull ResourceContainer resourceContainer) Adds this sound registry to the given resource container.
static @NotNull SoundRegistry.Builder	builder() Deprecated. Use soundRegistry() instead
@NotNull java.lang.String	namespace() Gets the sound registry namespace.
static @NotNull SoundRegistry	of(@NotNull java.lang.String namespace, @NotNull java.util.Set<SoundEvent> sounds) Deprecated. Use soundRegistry(String, Set) instead
@Nullable SoundEvent	sound(@NotNull net.kyori.adventure.key.Key key) Returns the sound event with the given key, or null if not found.
static @NotNull SoundRegistry.Builder	soundRegistry() Creates a new registry builder.
static @NotNull SoundRegistry	soundRegistry(@NotNull java.lang.String namespace, @NotNull java.util.Collection<SoundEvent> sounds) Creates a new registry from the given sounds.
static @NotNull SoundRegistry	soundRegistry(@NotNull java.lang.String namespace, @NotNull java.util.Set<SoundEvent> sounds) Creates a new registry from the given sounds.
@Unmodifiable @NotNull java.util.Collection<SoundEvent>	sounds() Returns an unmodifiable collection of the registered sound events.

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

compound, compound

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

soundRegistry

@NotNull
static @NotNull SoundRegistry soundRegistry(@NotNull
                                                      @NotNull java.lang.String namespace,
                                                      @NotNull
                                                      @NotNull java.util.Set<SoundEvent> sounds)

Creates a new registry from the given sounds.

Parameters:

namespace - The sound registry namespace

sounds - The registered sounds

Returns:

A new sound registry instance

Since:

1.1.0

soundRegistry

@NotNull
static @NotNull SoundRegistry soundRegistry(@NotNull
                                                      @NotNull java.lang.String namespace,
                                                      @NotNull
                                                      @NotNull java.util.Collection<SoundEvent> sounds)

Creates a new registry from the given sounds.

Parameters:

namespace - The sound registry namespace

sounds - The registered sounds

Returns:

A new sound registry instance

Since:

1.6.0

soundRegistry

@NotNull
static @NotNull SoundRegistry.Builder soundRegistry()

Creates a new registry builder.

Returns:

A new registry builder

Since:

1.1.0

of

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull SoundRegistry of(@NotNull
                                                                                                             @NotNull java.lang.String namespace,
                                                                                                             @NotNull
                                                                                                             @NotNull java.util.Set<SoundEvent> sounds)

Deprecated. Use soundRegistry(String, Set) instead

Creates a new registry from the given sounds

Parameters:

namespace - The sound registry namespace

sounds - The registered sounds

Returns:

A new sound registry instance

Since:

1.0.0

builder

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

Deprecated. Use soundRegistry() instead

Creates a new registry builder.

Returns:

A new registry builder

Since:

1.1.0

namespace

@Pattern(value="[a-z0-9_\\-.]+")
 @NotNull
@NotNull java.lang.String namespace()

Gets the sound registry namespace.

The returned namespace is a valid argument for the first parameter of Key.key(String, String).

Specified by:

namespace in interface net.kyori.adventure.key.Namespaced

Returns:

The sound registry namespace

Since:

1.0.0

sounds

@NotNull
@Unmodifiable @NotNull java.util.Collection<SoundEvent> sounds()

Returns an unmodifiable collection of the registered sound events.

Note that all the sound events in this collection will have a namespace equal to the registry namespace.

Returns:

The registered sound events

Since:

1.0.0

sound

@Nullable
@Nullable SoundEvent sound(@NotNull
                                      @NotNull net.kyori.adventure.key.Key key)

Returns the sound event with the given key, or null if not found.

Parameters:

key - The sound event key

Returns:

The sound event with the given key

Since:

1.0.0

addTo

default void addTo(@NotNull
                   @NotNull ResourceContainer resourceContainer)

Adds this sound registry to the given resource container.

Specified by:

addTo in interface ResourcePackPart

Parameters:

resourceContainer - The resource container

Since:

1.1.0