Class MusicInstrument

java.lang.Object

org.bukkit.MusicInstrument

All Implemented Interfaces:

net.kyori.adventure.key.Keyed, net.kyori.adventure.translation.Translatable, Keyed

@NullMarked
public abstract class MusicInstrument
extends Object
implements Keyed, net.kyori.adventure.translation.Translatable

Since:

1.19.3

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	create(Consumer<RegistryBuilderFactory<MusicInstrument, ? extends InstrumentRegistryEntry.Builder>> value)	Creates an inlined music instrument.
abstract net.kyori.adventure.text.Component	description()	Gets the description of this instrument as displayed to the client.
static @Nullable MusicInstrument	getByKey(NamespacedKey namespacedKey)	Deprecated. use Registry.get(NamespacedKey) instead
abstract float	getDuration()	Gets the use duration of this music instrument.
abstract 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.
abstract float	getRange()	Gets the range of the sound.
abstract Sound	getSound()	Gets the sound for this instrument.
@NotNull net.kyori.adventure.key.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 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 Collection<MusicInstrument>	values()	Deprecated. use Iterable.iterator()

Methods inherited from class Object

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

Field Details

ADMIRE_GOAT_HORN

public static final MusicInstrument ADMIRE_GOAT_HORN

Since:

1.20.6

CALL_GOAT_HORN

public static final MusicInstrument CALL_GOAT_HORN

Since:

1.20.6

DREAM_GOAT_HORN

public static final MusicInstrument DREAM_GOAT_HORN

Since:

1.20.6

FEEL_GOAT_HORN

public static final MusicInstrument FEEL_GOAT_HORN

Since:

1.20.6

PONDER_GOAT_HORN

public static final MusicInstrument PONDER_GOAT_HORN

Since:

1.20.6

SEEK_GOAT_HORN

public static final MusicInstrument SEEK_GOAT_HORN

Since:

1.20.6

SING_GOAT_HORN

public static final MusicInstrument SING_GOAT_HORN

Since:

1.20.6

YEARN_GOAT_HORN

public static final MusicInstrument YEARN_GOAT_HORN

Since:

1.20.6

Constructor Details

MusicInstrument

public MusicInstrument()

Method Details

create

public static MusicInstrument create(Consumer<RegistryBuilderFactory<MusicInstrument, ? extends InstrumentRegistryEntry.Builder>> value)

Creates an inlined music instrument.

Parameters:

value - a consumer for the builder factory

Returns:

the created music instrument

Since:

1.21.7

getByKey

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

Deprecated.

use Registry.get(NamespacedKey) instead

Returns a MusicInstrument by a NamespacedKey.

Parameters:

namespacedKey - the key

Returns:

the event or null

Since:

1.19.3

values

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

Deprecated.

use Iterable.iterator()

Returns all known music instruments.

Returns:

the music instruments

Since:

1.19.3

getDuration

public abstract float getDuration()

Gets the use duration of this music instrument.

Returns:

the duration expressed in seconds

Since:

1.21.6

getRange

public abstract float getRange()

Gets the range of the sound.

Returns:

the range of the sound

Since:

1.21.6

description

public abstract net.kyori.adventure.text.Component description()

Gets the description of this instrument as displayed to the client.

Returns:

the description component

Since:

1.21.6

getSound

public abstract Sound getSound()

Gets the sound for this instrument.

Returns:

the sound

Since:

1.21.6

getKey

@Deprecated(forRemoval=true,
            since="1.20.5")
public abstract 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 net.kyori.adventure.key.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 net.kyori.adventure.key.Keyed

Specified by:

key in interface Keyed

Returns:

this object's key

translationKey

@Deprecated(forRemoval=true)
public abstract 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.

Specified by:

translationKey in interface net.kyori.adventure.translation.Translatable