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>

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
  • 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