Uses of Interface
net.kyori.adventure.key.Key

Packages that use Key

Package	Description
net.kyori.adventure.chat	Chat-related data.
net.kyori.adventure.key	A reference composed of a namespace and a path.
net.kyori.adventure.pointer	Key/Value based pointers to information.
net.kyori.adventure.sound	Data for controlling sound playback.
net.kyori.adventure.text	Data for controlling components, their styles, and events.
net.kyori.adventure.text.event	Events that occur when players interact with components.
net.kyori.adventure.text.format	Formats which may be applied to components.
net.kyori.adventure.text.minimessage.translation	Tools for working with Adventure's translation API.
net.kyori.adventure.text.object	Types related to ObjectComponent.
net.kyori.adventure.text.serializer.gson.impl	Internal classes for the Gson serializer.
net.kyori.adventure.translation	Translations and translation registries.

Uses of Key in net.kyori.adventure.chat

Methods in net.kyori.adventure.chat that return Key

Modifier and Type	Method	Description
@Nullable Key	ChatType.key()	Gets the key associated with this chat type.

Uses of Key in net.kyori.adventure.key

Subinterfaces with type arguments of type Key in net.kyori.adventure.key

Modifier and Type	Interface	Description
interface	Key	An identifying object used to fetch and/or store unique objects.

Methods in net.kyori.adventure.key that return Key

Modifier and Type	Method	Description
default Key	Key.key()
static Key	Key.key(String string)	Creates a key.
static Key	Key.key(String string, char character)	Creates a key.
static Key	Key.key(String namespace, String value)	Creates a key.
static Key	Key.key(Namespaced namespaced, String value)	Creates a key.
Key	Keyed.key()	Gets the key.

Methods in net.kyori.adventure.key that return types with arguments of type Key

Modifier and Type	Method	Description
static Comparator<? super Key>	Key.comparator()	Gets the comparator.

Methods in net.kyori.adventure.key with parameters of type Key

Modifier and Type	Method	Description
default int	Key.compareTo(Key that)
static <T> KeyedValue<T>	KeyedValue.keyedValue(Key key, T value)	Creates a link.

Uses of Key in net.kyori.adventure.pointer

Methods in net.kyori.adventure.pointer that return Key

Modifier and Type	Method	Description
Key	Pointer.key()	Gets the key.

Methods in net.kyori.adventure.pointer with parameters of type Key

Modifier and Type	Method	Description
static <V> Pointer<V>	Pointer.pointer(Class<V> type, Key key)	Creates a pointer.

Uses of Key in net.kyori.adventure.sound

Methods in net.kyori.adventure.sound that return Key

Modifier and Type	Method	Description
Key	Sound.Type.key()	Gets the key.
Key	Sound.name()	Gets the name.
@Nullable Key	SoundStop.sound()	Gets the sound.

Methods in net.kyori.adventure.sound with parameters of type Key

Modifier and Type	Method	Description
static SoundStop	SoundStop.named(Key sound)	Stops all sounds named sound.
static SoundStop	SoundStop.namedOnSource(Key sound, Sound.Source source)	Stops all sounds named name on source source.
static Sound	Sound.sound(Key name, Sound.Source.Provider source, float volume, float pitch)	Creates a new sound.
static Sound	Sound.sound(Key name, Sound.Source source, float volume, float pitch)	Creates a new sound.
Sound.Builder	Sound.Builder.type(Key type)	Set the type of this sound.

Uses of Key in net.kyori.adventure.text

Methods in net.kyori.adventure.text that return Key

Modifier and Type	Method	Description
default @Nullable Key	Component.font()	Gets the font.
Key	StorageNBTComponent.storage()	Gets the NBT storage's ID.

Methods in net.kyori.adventure.text with parameters of type Key

Modifier and Type	Method	Description
default Component	Component.font(@Nullable Key key)	Sets the font.
B	ComponentBuilder.font(@Nullable Key font)	Sets the font of this component.
default C	ScopedComponent.font(@Nullable Key key)
StorageNBTComponent.Builder	StorageNBTComponent.Builder.storage(Key storage)	Sets the NBT storage.
StorageNBTComponent	StorageNBTComponent.storage(Key storage)	Sets the NBT storage.
static StorageNBTComponent	Component.storageNBT(String nbtPath, boolean interpret, Key storage)	Creates a storage NBT component with a path and an storage ID.
static StorageNBTComponent	Component.storageNBT(String nbtPath, boolean interpret, @Nullable ComponentLike separator, Key storage)	Creates a storage NBT component with a path and an storage ID.
static StorageNBTComponent	Component.storageNBT(String nbtPath, Key storage)	Creates a storage NBT component with a path and an storage ID.

Uses of Key in net.kyori.adventure.text.event

Methods in net.kyori.adventure.text.event that return Key

Modifier and Type	Method	Description
Key	DataComponentValueConverterRegistry.Provider.id()	An identifier for this provider.
Key	HoverEvent.ShowItem.item()	Gets the item.
Key	HoverEvent.ShowEntity.type()	Gets the type.

Methods in net.kyori.adventure.text.event that return types with arguments of type Key

Modifier and Type	Method	Description
Map<Key, DataComponentValue>	HoverEvent.ShowItem.dataComponents()	Get the data components used for this item.
<V extends DataComponentValue> Map<Key,V>	HoverEvent.ShowItem.dataComponentsAs(Class<V> targetType)	Return an unmodifiable map of data components coerced to the target type.
static Set<Key>	DataComponentValueConverterRegistry.knownProviders()	Get the id's of all registered conversion providers.

Methods in net.kyori.adventure.text.event with parameters of type Key

Modifier and Type	Method	Description
O	DataComponentValueConverterRegistry.Conversion.convert(Key key, I input)	Perform the actual conversion.
static <O extends DataComponentValue> O	DataComponentValueConverterRegistry.convert(Class<O> target, Key key, DataComponentValue in)	Try to convert the data component value in to the provided output type.
static ClickEvent<ClickEvent.Payload.Custom>	ClickEvent.custom(Key key)	Creates a click event that sends a custom event to the server.
static ClickEvent<ClickEvent.Payload.Custom>	ClickEvent.custom(Key key, @Nullable BinaryTagHolder nbt)	Creates a click event that sends a custom event to the server.
static ClickEvent.Payload.Custom	ClickEvent.Payload.custom(Key key)	Creates a custom payload.
static ClickEvent.Payload.Custom	ClickEvent.Payload.custom(Key key, @Nullable BinaryTagHolder nbt)	Creates a custom payload.
HoverEvent.ShowItem	HoverEvent.ShowItem.item(Key item)	Sets the item.
static HoverEvent<HoverEvent.ShowEntity>	HoverEvent.showEntity(Key type, UUID id)	Creates a hover event that show information about an entity on hover.
static HoverEvent<HoverEvent.ShowEntity>	HoverEvent.showEntity(Key type, UUID id, @Nullable Component name)	Creates a hover event that show information about an entity on hover.
static HoverEvent.ShowEntity	HoverEvent.ShowEntity.showEntity(Key type, UUID id)	Creates.
static HoverEvent.ShowEntity	HoverEvent.ShowEntity.showEntity(Key type, UUID id, @Nullable Component name)	Creates.
static HoverEvent<HoverEvent.ShowItem>	HoverEvent.showItem(Key item, @Range(from=0L,to=2147483647L) int count)	Creates a hover event that shows an item on hover.
static HoverEvent<HoverEvent.ShowItem>	HoverEvent.showItem(Key item, @Range(from=0L,to=2147483647L) int count, @Nullable BinaryTagHolder nbt)	Creates a hover event that shows an item on hover.
static HoverEvent.ShowItem	HoverEvent.ShowItem.showItem(Key item, @Range(from=0L,to=2147483647L) int count)	Creates.
static HoverEvent.ShowItem	HoverEvent.ShowItem.showItem(Key item, @Range(from=0L,to=2147483647L) int count, @Nullable BinaryTagHolder nbt)	Creates.
HoverEvent.ShowEntity	HoverEvent.ShowEntity.type(Key type)	Sets the type.

Method parameters in net.kyori.adventure.text.event with type arguments of type Key

Modifier and Type	Method	Description
static <I1,O1> DataComponentValueConverterRegistry.Conversion<I1,O1>	DataComponentValueConverterRegistry.Conversion.convert(Class<I1> src, Class<O1> dst, BiFunction<Key,I1,O1> op)	Create a new conversion.
HoverEvent.ShowItem	HoverEvent.ShowItem.dataComponents(Map<Key, DataComponentValue> holder)	Set the data components used on this item.
static HoverEvent<HoverEvent.ShowItem>	HoverEvent.showItem(Keyed item, @Range(from=0L,to=2147483647L) int count, Map<Key, ? extends DataComponentValue> dataComponents)	Creates a hover event that shows an item on hover.
static HoverEvent.ShowItem	HoverEvent.ShowItem.showItem(Keyed item, @Range(from=0L,to=2147483647L) int count, Map<Key, ? extends DataComponentValue> dataComponents)	Creates.

Uses of Key in net.kyori.adventure.text.format

Fields in net.kyori.adventure.text.format declared as Key

Modifier and Type	Field	Description
static final Key	Style.DEFAULT_FONT	The default font.

Methods in net.kyori.adventure.text.format that return Key

Modifier and Type	Method	Description
@Nullable Key	Style.font()	Gets the font.
@Nullable Key	StyleGetter.font()	Gets the font.

Methods in net.kyori.adventure.text.format with parameters of type Key

Modifier and Type	Method	Description
Style.Builder	Style.Builder.font(@Nullable Key font)	Sets the font.
Style	Style.font(@Nullable Key font)	Sets the font.
T	StyleSetter.font(@Nullable Key font)	Sets the font.

Uses of Key in net.kyori.adventure.text.minimessage.translation

Methods in net.kyori.adventure.text.minimessage.translation with parameters of type Key

Modifier and Type	Method	Description
static MiniMessageTranslationStore	MiniMessageTranslationStore.create(Key name)	Creates a MiniMessage translation store, backed by the default MiniMessage instance.
static MiniMessageTranslationStore	MiniMessageTranslationStore.create(Key name, MiniMessage miniMessage)	Creates a MiniMessage translation store.

Uses of Key in net.kyori.adventure.text.object

Fields in net.kyori.adventure.text.object declared as Key

Modifier and Type	Field	Description
static final Key	SpriteObjectContents.DEFAULT_ATLAS	The default atlas key for sprites, used by vanilla when the atlas is not specified in a serialized object component.

Methods in net.kyori.adventure.text.object that return Key

Modifier and Type	Method	Description
Key	SpriteObjectContents.atlas()	Gets the atlas key.
Key	SpriteObjectContents.sprite()	Gets the sprite key.
@Nullable Key	PlayerHeadObjectContents.texture()	Optional namespaced ID of the skin texture to use for rendering.

Methods in net.kyori.adventure.text.object with parameters of type Key

Modifier and Type	Method	Description
static SpriteObjectContents	ObjectContents.sprite(Key sprite)	Creates a sprite contents with the given sprite and the default atlas.
static SpriteObjectContents	ObjectContents.sprite(Key atlas, Key sprite)	Creates a sprite contents with the given atlas and sprite.
PlayerHeadObjectContents.Builder	PlayerHeadObjectContents.Builder.texture(@Nullable Key texture)	Sets the optional namespaced ID of the skin texture to use for rendering.

Uses of Key in net.kyori.adventure.text.serializer.gson.impl

Methods in net.kyori.adventure.text.serializer.gson.impl that return Key

Modifier and Type	Method	Description
Key	GsonDataComponentValueConverterProvider.id()

Uses of Key in net.kyori.adventure.translation

Methods in net.kyori.adventure.translation that return Key

Modifier and Type	Method	Description
final Key	AbstractTranslationStore.name()
Key	Translator.name()	A key identifying this translation source.

Methods in net.kyori.adventure.translation with parameters of type Key

Modifier and Type	Method	Description
static TranslationStore<Component>	TranslationStore.component(Key name)	Creates a new translation store that uses component-based translation.
static TranslationStore.StringBased<MessageFormat>	TranslationStore.messageFormat(Key name)	Creates a new translation store that uses message-format-based translation.

Constructors in net.kyori.adventure.translation with parameters of type Key

Modifier	Constructor	Description
protected	AbstractTranslationStore(Key name)	Creates a new abstract translation store with a given name.
protected	StringBased(Key name)	Creates a new abstract, string-based translation store with a given name.