Package org.bukkit

Class MusicInstrument

java.lang.Object

org.bukkit.MusicInstrument

All Implemented Interfaces:

Keyed, RegistryAware

public abstract class MusicInstrument
extends Object
implements Keyed, RegistryAware

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 MusicInstrument	getByKey(NamespacedKey namespacedKey)	Deprecated. Use Registry.get(NamespacedKey) instead.
abstract String	getDescription()	Gets the description of this instrument.
abstract float	getDuration()	Gets how long the use duration is for the instrument.
abstract NamespacedKey	getKey()	Deprecated. A key might not always be present, use RegistryAware.getKeyOrThrow() instead.
abstract float	getRange()	Gets the range of the sound.
abstract Sound	getSoundEvent()	Gets the sound/sound-event for this instrument.
static 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

Methods inherited from interface org.bukkit.registry.RegistryAware

getKeyOrNull, getKeyOrThrow, isRegistered

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

getDuration

public abstract float getDuration()

Gets how long the use duration is for the instrument.

Returns:

the duration.

getRange

public abstract float getRange()

Gets the range of the sound.

Returns:

the range of the sound.

getDescription

@NotNull
public abstract String getDescription()

Gets the description of this instrument.

Returns:

the description.

getSoundEvent

@NotNull
public abstract Sound getSoundEvent()

Gets the sound/sound-event for this instrument.

Returns:

a sound.

getKey

@NotNull
@Deprecated(since="1.21.4")
public abstract NamespacedKey getKey()

Deprecated.

A key might not always be present, use RegistryAware.getKeyOrThrow() instead.

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

See Also:

• RegistryAware.getKeyOrThrow()
• RegistryAware.isRegistered()

getByKey

@Nullable
@Deprecated(since="1.20.1")
public static MusicInstrument getByKey(@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 Collection<MusicInstrument> values()

Deprecated.

use Iterable.iterator().

Returns all known MusicInstruments.

Returns:

the memoryKeys