Package studio.mevera.imperat.command.tree.help.renderers

Class StandardHelpRenderer<S extends CommandSource,C>

java.lang.Object

studio.mevera.imperat.command.tree.help.renderers.StandardHelpRenderer<S,C>

Type Parameters:

S - the source type

C - the component type

All Implemented Interfaces:

HelpLayoutRenderer<S,C>

public final class StandardHelpRenderer<S extends CommandSource,C>
extends Object
implements HelpLayoutRenderer<S,C>

Standard help renderer that displays help entries in a flat list format. Each entry is formatted using the theme's usage formatter and sent to the source.

Constructor Summary

Constructors

Constructor	Description
StandardHelpRenderer()

Method Summary

Modifier and Type	Method	Description
void	render(@NotNull ExecutionContext<S> context, @NotNull HelpEntryList<S> helpEntries, @NotNull HelpTheme<S,C> theme)	Renders the help documentation to the source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StandardHelpRenderer

public StandardHelpRenderer()

Method Details

render

public void render(@NotNull
 @NotNull ExecutionContext<S> context,
 @NotNull
 @NotNull HelpEntryList<S> helpEntries,
 @NotNull
 @NotNull HelpTheme<S,C> theme)

Description copied from interface: HelpLayoutRenderer

Renders the help documentation to the source.

Specified by:

render in interface HelpLayoutRenderer<S extends CommandSource,C>

Parameters:

context - The execution context, containing information about the command and source.

helpEntries - A list of all available help entries for the current context.

theme - The theme that controls how the help is displayed.