Package io.papermc.paper.registry.data

Interface InstrumentRegistryEntry

All Known Subinterfaces:

InstrumentRegistryEntry.Builder

@Experimental
@NonExtendable
public interface InstrumentRegistryEntry

A data-centric version-specific registry entry for the MusicInstrument type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	InstrumentRegistryEntry.Builder	A mutable builder for the InstrumentRegistryEntry plugins may change in applicable registry events.

Method Summary

Modifier and Type	Method	Description
Component	description()	Provides the description of the instrument, which is used in the item tooltip.
@org.checkerframework.checker.index.qual.Positive float	duration()	Provides the duration of the instrument, which is time to use.
@org.checkerframework.checker.index.qual.Positive float	range()	Provides the range of the instrument, which is range of the sound.
RegistryHolder<Sound,SoundEventRegistryEntry>	soundEvent()	Provides the sound event of the instrument.

Method Details

soundEvent

@Contract(pure=true)
RegistryHolder<Sound,SoundEventRegistryEntry> soundEvent()

Provides the sound event of the instrument.

Returns:

the sound event.

See Also:

• MusicInstrument.getSound()

duration

@Contract(pure=true)
@org.checkerframework.checker.index.qual.Positive float duration()

Provides the duration of the instrument, which is time to use.

Returns:

the duration.

See Also:

• MusicInstrument.getDuration()

range

@Contract(pure=true)
@org.checkerframework.checker.index.qual.Positive float range()

Provides the range of the instrument, which is range of the sound.

Returns:

the range.

See Also:

• MusicInstrument.getRange()

description

@Contract(pure=true)
Component description()

Provides the description of the instrument, which is used in the item tooltip.

Returns:

the description.

See Also:

• MusicInstrument.description()