Interface TranslatableComponent

All Superinterfaces:
Buildable<TranslatableComponent,​TranslatableComponent.Builder>, BuildableComponent<TranslatableComponent,​TranslatableComponent.Builder>, Component, ComponentBuilderApplicable, ComponentLike, net.kyori.examination.Examinable, HoverEventSource<Component>, ScopedComponent<TranslatableComponent>

public interface TranslatableComponent
extends BuildableComponent<TranslatableComponent,​TranslatableComponent.Builder>, ScopedComponent<TranslatableComponent>
A translatable component.
Since:
4.0.0
  • Method Details

    • key

      @NonNull String key()
      Gets the translation key.
      Returns:
      the translation key
      Since:
      4.0.0
    • key

      @NonNull TranslatableComponent key​(@NonNull String key)
      Sets the translation key.
      Parameters:
      key - the translation key
      Returns:
      a translatable component
      Since:
      4.0.0
    • args

      @NonNull List<Component> args()
      Gets the unmodifiable list of translation arguments.
      Returns:
      the unmodifiable list of translation arguments
      Since:
      4.0.0
    • args

      @NonNull TranslatableComponent args​(@NonNull ComponentLike @NonNull ... args)
      Sets the translation arguments for this component.
      Parameters:
      args - the translation arguments
      Returns:
      a translatable component
      Since:
      4.0.0
    • args

      @NonNull TranslatableComponent args​(@NonNull List<? extends ComponentLike> args)
      Sets the translation arguments for this component.
      Parameters:
      args - the translation arguments
      Returns:
      a translatable component
      Since:
      4.0.0