Package net.kyori.adventure.text

Interface KeybindComponent

All Superinterfaces:

Buildable<KeybindComponent,KeybindComponent.Builder>, BuildableComponent<KeybindComponent,KeybindComponent.Builder>, Component, ComponentBuilderApplicable, ComponentLike, net.kyori.examination.Examinable, HoverEventSource<Component>, ScopedComponent<KeybindComponent>, StyleGetter, StyleSetter<Component>

public interface KeybindComponent
extends BuildableComponent<KeybindComponent,KeybindComponent.Builder>, ScopedComponent<KeybindComponent>

A Component that displays the client's current keybind for the supplied action.

This component takes:

keybind

a keybind identifier for a action. (e.g key.inventory, key.jump etc..)

Since:

4.0.0

Since Minecraft:

1.12

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	KeybindComponent.Builder	A keybind component builder.
static interface	KeybindComponent.KeybindLike	Something that can provide a keybind identifier.

Field Summary

Fields inherited from interface net.kyori.adventure.text.Component

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty>	examinableProperties()
@NotNull String	keybind()	Gets the keybind.
@NotNull KeybindComponent	keybind(@NotNull String keybind)	Sets the keybind.
default @NotNull KeybindComponent	keybind(@NotNull KeybindComponent.KeybindLike keybind)	Sets the keybind.

Methods inherited from interface net.kyori.adventure.text.BuildableComponent

toBuilder

Methods inherited from interface net.kyori.adventure.text.Component

asHoverEvent, children, clickEvent, color, compact, compact, componentBuilderApply, contains, contains, decoration, decorations, detectCycle, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, shadowColor, spliterator, spliterator, style

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Methods inherited from interface net.kyori.adventure.text.ScopedComponent

append, append, append, append, append, appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, decorationIfAbsent, decorations, font, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, shadowColor, shadowColorIfAbsent, style, style, style, style

Methods inherited from interface net.kyori.adventure.text.format.StyleSetter

decorate, decorations

Method Details

keybind

@NotNull
@NotNull String keybind()

Gets the keybind.

Returns:

the keybind

Since:

4.0.0

keybind

@Contract(pure=true)
@NotNull
@NotNull KeybindComponent keybind(@NotNull
 @NotNull String keybind)

Sets the keybind.

Parameters:

keybind - the keybind

Returns:

a copy of this component

Since:

4.0.0

keybind

@Contract(pure=true)
@NotNull
default @NotNull KeybindComponent keybind(@NotNull
 @NotNull KeybindComponent.KeybindLike keybind)

Sets the keybind.

Parameters:

keybind - the keybind

Returns:

a copy of this component

Since:

4.9.0

examinableProperties

@NotNull
default @NotNull Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()

Specified by:

examinableProperties in interface Component

Specified by:

examinableProperties in interface net.kyori.examination.Examinable