Package org.bukkit

Class MusicInstrument

java.lang.Object

org.bukkit.MusicInstrument

All Implemented Interfaces:

Keyed, Translatable, Keyed

public abstract class MusicInstrument
extends Object
implements Keyed, Translatable

Field Summary

Fields

Modifier and Type	Field	Description
static final MusicInstrument	ADMIRE_GOAT_HORN
static final MusicInstrument	CALL_GOAT_HORN
static final MusicInstrument	DREAM_GOAT_HORN
static final MusicInstrument	FEEL_GOAT_HORN
static final MusicInstrument	PONDER_GOAT_HORN
static final MusicInstrument	SEEK_GOAT_HORN
static final MusicInstrument	SING_GOAT_HORN
static final MusicInstrument	YEARN_GOAT_HORN

Constructor Summary

Constructors

Constructor	Description
MusicInstrument()

Method Summary

Modifier and Type	Method	Description
static @Nullable MusicInstrument	getByKey(@NotNull NamespacedKey namespacedKey)	Deprecated. Use Registry.get(NamespacedKey) instead.
abstract @NotNull NamespacedKey	getKey()	Deprecated, for removal: This API element is subject to removal in a future version. use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.INSTRUMENT.
@NotNull Key	key()	Deprecated, for removal: This API element is subject to removal in a future version. use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.INSTRUMENT.
abstract @NotNull String	translationKey()	Deprecated, for removal: This API element is subject to removal in a future version. this method assumes that the instrument description always be a translatable component which is not guaranteed.
static @NotNull Collection<MusicInstrument>	values()	Deprecated. use Iterable.iterator().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PONDER_GOAT_HORN

public static final MusicInstrument PONDER_GOAT_HORN

SING_GOAT_HORN

public static final MusicInstrument SING_GOAT_HORN

SEEK_GOAT_HORN

public static final MusicInstrument SEEK_GOAT_HORN

FEEL_GOAT_HORN

public static final MusicInstrument FEEL_GOAT_HORN

ADMIRE_GOAT_HORN

public static final MusicInstrument ADMIRE_GOAT_HORN

CALL_GOAT_HORN

public static final MusicInstrument CALL_GOAT_HORN

YEARN_GOAT_HORN

public static final MusicInstrument YEARN_GOAT_HORN

DREAM_GOAT_HORN

public static final MusicInstrument DREAM_GOAT_HORN

Constructor Details

MusicInstrument

public MusicInstrument()

Method Details

getByKey

@Nullable
@Deprecated(since="1.20.1")
public static @Nullable MusicInstrument getByKey(@NotNull
 @NotNull NamespacedKey namespacedKey)

Deprecated.

Use Registry.get(NamespacedKey) instead.

Returns a MusicInstrument by a NamespacedKey.

Parameters:

namespacedKey - the key

Returns:

the event or null

values

@NotNull
@Deprecated(since="1.20.1")
public static @NotNull Collection<MusicInstrument> values()

Deprecated.

use Iterable.iterator().

Returns all known MusicInstruments.

Returns:

the memoryKeys

getKey

@Deprecated(forRemoval=true,
            since="1.20.5")
@NotNull
public abstract @NotNull NamespacedKey getKey()

Deprecated, for removal: This API element is subject to removal in a future version.

use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.INSTRUMENT. MusicInstruments can exist without a key.

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

key

@Deprecated(forRemoval=true,
            since="1.20.5")
public @NotNull Key key()

Deprecated, for removal: This API element is subject to removal in a future version.

use Registry.getKey(Keyed), RegistryAccess.getRegistry(io.papermc.paper.registry.RegistryKey), and RegistryKey.INSTRUMENT. MusicInstruments can exist without a key.

Description copied from interface: Keyed

Returns the unique identifier for this object.

Specified by:

key in interface Keyed

Specified by:

key in interface Keyed

Returns:

this object's key

translationKey

@Deprecated(forRemoval=true)
@NotNull
public abstract @NotNull String translationKey()

Deprecated, for removal: This API element is subject to removal in a future version.

this method assumes that the instrument description always be a translatable component which is not guaranteed.

Description copied from interface: net.kyori.adventure.translation.Translatable

Gets the translation key.

Specified by:

translationKey in interface Translatable

Returns:

the translation key