Package org.geysermc.geyser.inventory.item

Interface GeyserInstrument

All Known Implementing Classes:

GeyserInstrument.Impl, GeyserInstrument.Wrapper

public interface GeyserInstrument

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	GeyserInstrument.BedrockInstrument	Each vanilla instrument on Bedrock, ordered in their network IDs.
static final record	GeyserInstrument.Impl
static final record	GeyserInstrument.Wrapper

Method Summary

Modifier and Type	Method	Description
default int	bedrockId()
static int	bedrockIdToJava(GeyserSession session, int id)
GeyserInstrument.BedrockInstrument	bedrockInstrument()
String	description()	In Bedrock format
static GeyserInstrument	fromComponent(GeyserSession session, org.geysermc.mcprotocollib.protocol.data.game.item.component.InstrumentComponent component)
float	range()
static GeyserInstrument	read(RegistryEntryContext context)
String	soundEvent()

Method Details

read

static GeyserInstrument read(RegistryEntryContext context)

soundEvent

String soundEvent()

range

float range()

description

String description()

In Bedrock format

bedrockInstrument

GeyserInstrument.BedrockInstrument bedrockInstrument()

bedrockId

default int bedrockId()

Returns:

the ID of the Bedrock counterpart for this instrument. If there is none (bedrockInstrument() is null), then -1 is returned.

bedrockIdToJava

static int bedrockIdToJava(GeyserSession session,
 int id)

Returns:

the ID of the Java counterpart for the given Bedrock ID. If an invalid Bedrock ID was given, or there is no counterpart, -1 is returned.

fromComponent

static GeyserInstrument fromComponent(GeyserSession session,
 org.geysermc.mcprotocollib.protocol.data.game.item.component.InstrumentComponent component)