Package io.github.mqzn.commands.help

Interface CommandHelpProvider

public interface CommandHelpProvider

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull net.kyori.adventure.text.TextComponent
    header(String label)
    The header of the help topic
    @NotNull net.kyori.adventure.text.format.Style
    lineStyle()
    The line style of the help topic
    <S> @NotNull net.kyori.adventure.text.format.Style
    syntaxStyle(@NotNull CommandSyntax<S> syntax)
    The style of the syntax of a command

  • Method Details

    • lineStyle

      @NotNull @NotNull net.kyori.adventure.text.format.Style lineStyle()
      The line style of the help topic
      Returns:
      how the line is displayed in the help topic e.g: "[style]========== Help Menu [style]============
      See Also:
      • Style

    • header

      @NotNull @NotNull net.kyori.adventure.text.TextComponent header(String label)
      The header of the help topic
      Parameters:
      label - the command label (name)
      Returns:
      the header of the help topic

    • syntaxStyle

      @NotNull <S> @NotNull net.kyori.adventure.text.format.Style syntaxStyle(@NotNull @NotNull CommandSyntax<S> syntax)
      The style of the syntax of a command
      Type Parameters:
      S - the sender type param
      Parameters:
      syntax - the syntax of a command
      Returns:
      The style of the syntax of a command