Package io.github.mqzn.commands.help

Interface CommandHelpStyle<S>

All Known Implementing Classes:

CommandHelpStyle.ImmutableHelpStyle

public interface CommandHelpStyle<S>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CommandHelpStyle.Builder<S>
static final record	CommandHelpStyle.ImmutableHelpStyle<S>

Method Summary

Modifier and Type	Method	Description
static <S> CommandHelpStyle.Builder<S>	builder()
@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
@NotNull net.kyori.adventure.text.format.Style	syntaxStyle(@NotNull CommandSyntax<S> syntax)	The style of the syntax of a command

Method Details

builder

static <S> CommandHelpStyle.Builder<S> builder()

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
@NotNull net.kyori.adventure.text.format.Style syntaxStyle(@NotNull
 @NotNull CommandSyntax<S> syntax)

The style of the syntax of a command

Parameters:

syntax - the syntax of a command

Returns:

The style of the syntax of a command