Interface KeybindComponent

All Superinterfaces:

Component, ComponentBuilderApplicable, ComponentLike, HoverEventSource<Component>, ScopedComponent<KeybindComponent>, StyleGetter, StyleSetter<Component>

public sealed interface KeybindComponent
extends 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 Component

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
String	keybind()	Gets the keybind.
KeybindComponent	keybind(String keybind)	Sets the keybind.
default KeybindComponent	keybind(KeybindComponent.KeybindLike keybind)	Sets the keybind.
KeybindComponent.Builder	toBuilder()	Returns a builder for this component.

Methods inherited from interface Component

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

Methods inherited from interface HoverEventSource

asHoverEvent

Methods inherited from interface 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 StyleSetter

decorate, decorations

Method Details

keybind

String keybind()

Gets the keybind.

Returns:

the keybind

Since:

4.0.0

keybind

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

Sets the keybind.

Parameters:

keybind - the keybind

Returns:

a copy of this component

Since:

4.0.0

keybind

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

Sets the keybind.

Parameters:

keybind - the keybind

Returns:

a copy of this component

Since:

4.9.0

toBuilder

KeybindComponent.Builder toBuilder()

Description copied from interface: Component

Returns a builder for this component.

Specified by:

toBuilder in interface Component

Specified by:

toBuilder in interface ScopedComponent<KeybindComponent>

Returns:

the builder