Package org.incendo.cloud.minecraft.extras

Class MinecraftHelp<C>

java.lang.Object

org.incendo.cloud.minecraft.extras.MinecraftHelp<C>

Type Parameters:

C - command sender type

Direct Known Subclasses:

ImmutableMinecraftHelp

@Immutable
public abstract class MinecraftHelp<C>
extends Object

Opinionated extension of HelpRenderer for Minecraft.

This class should not be extended, and the only implementation of it is ImmutableMinecraftHelp.

You may customize certain aspects of the help menu by using the builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MinecraftHelp.DescriptionDecorator<C>
static interface	MinecraftHelp.HelpColors	Class for holding the TextColors used for help menus
static interface	MinecraftHelp.MessageProvider<C>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_HEADER_FOOTER_LENGTH
static final MinecraftHelp.HelpColors	DEFAULT_HELP_COLORS	The default color scheme for MinecraftHelp
static final int	DEFAULT_MAX_RESULTS_PER_PAGE
static final String	MESSAGE_ARGUMENTS
static final String	MESSAGE_AVAILABLE_COMMANDS
static final String	MESSAGE_CLICK_FOR_NEXT_PAGE
static final String	MESSAGE_CLICK_FOR_PREVIOUS_PAGE
static final String	MESSAGE_CLICK_TO_SHOW_HELP
static final String	MESSAGE_COMMAND
static final String	MESSAGE_DESCRIPTION
static final String	MESSAGE_HELP_TITLE
static final String	MESSAGE_NO_DESCRIPTION
static final String	MESSAGE_NO_RESULTS_FOR_QUERY
static final String	MESSAGE_OPTIONAL
static final String	MESSAGE_PAGE_OUT_OF_RANGE
static final String	MESSAGE_SHOWING_RESULTS_FOR_QUERY

Method Summary

Modifier and Type	Method	Description
@NonNull Audience	audience(@NonNull C sender)	Maps a command sender to an Audience
abstract @NonNull AudienceProvider<C>	audienceProvider()	Returns the audience provider that was used to create this instance.
static <C> @NonNull ImmutableMinecraftHelp.CommandManagerBuildStage<C>	builder()	Returns a new MinecraftHelp builder.
static <C> MinecraftHelp.MessageProvider<C>	captionMessageProvider(CaptionRegistry<C> registry, ComponentCaptionFormatter<C> formatter)	Creates a MinecraftHelp.MessageProvider that delegates to the provided CaptionRegistry and ComponentCaptionFormatter.
@NonNull MinecraftHelp.HelpColors	colors()	Returns the colors used for help messages.
@NonNull CommandPredicate<C>	commandFilter()	Returns the filter that determines what commands are visible inside the help menu.
abstract @NonNull CommandManager<C>	commandManager()	Returns the command manager instance.
abstract @NonNull String	commandPrefix()	Returns the command prefix.
static <C> @NonNull MinecraftHelp<C>	create(@NonNull String commandPrefix, @NonNull CommandManager<C> commandManager, @NonNull AudienceProvider<C> audienceProvider)	Constructs a new Minecraft help instance using the default values.
static <C extends Audience> @NonNull MinecraftHelp<C>	createNative(@NonNull String commandPrefix, @NonNull CommandManager<C> commandManager)	Constructs a new Minecraft help instance for a sender type which is an Audience.
static <C> CaptionProvider<C>	defaultCaptionsProvider()	Returns a CaptionProvider for the default messages.
@NonNull MinecraftHelp.DescriptionDecorator<C>	descriptionDecorator()	Returns the description decorator which turns descriptions into components.
@org.checkerframework.checker.index.qual.NonNegative int	headerFooterLength()	Returns the length of the header/footer of help menus.
static @NonNull MinecraftHelp.HelpColors	helpColors(@NonNull TextColor primary, @NonNull TextColor highlight, @NonNull TextColor alternateHighlight, @NonNull TextColor text, @NonNull TextColor accent)	Creates a new MinecraftHelp.HelpColors instance.
@NonNull HelpHandler<C>	helpHandler()	Returns the help handler.
@org.checkerframework.checker.index.qual.NonNegative int	maxResultsPerPage()	Returns the maximum number of help results to display on a page.
protected final @NonNull String	messageOrDefault(@NonNull String key)
@NonNull MinecraftHelp.MessageProvider<C>	messageProvider()	Returns the message provider which is used to retrieve messages from message keys.
abstract @NonNull Map<@NonNull String,@NonNull String>	messages()	Returns the messages which are used by the default MinecraftHelp.MessageProvider.
void	queryCommands(@NonNull String rawQuery, @NonNull C recipient)	Queries commands and send the results to the recipient.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_HEADER_FOOTER_LENGTH

public static final int DEFAULT_HEADER_FOOTER_LENGTH

See Also:

• Constant Field Values

DEFAULT_MAX_RESULTS_PER_PAGE

public static final int DEFAULT_MAX_RESULTS_PER_PAGE

See Also:

• Constant Field Values

DEFAULT_HELP_COLORS

public static final MinecraftHelp.HelpColors DEFAULT_HELP_COLORS

The default color scheme for MinecraftHelp

MESSAGE_HELP_TITLE

public static final String MESSAGE_HELP_TITLE

See Also:

• Constant Field Values

MESSAGE_COMMAND

public static final String MESSAGE_COMMAND

See Also:

• Constant Field Values

MESSAGE_DESCRIPTION

public static final String MESSAGE_DESCRIPTION

See Also:

• Constant Field Values

MESSAGE_NO_DESCRIPTION

public static final String MESSAGE_NO_DESCRIPTION

See Also:

• Constant Field Values

MESSAGE_ARGUMENTS

public static final String MESSAGE_ARGUMENTS

See Also:

• Constant Field Values

MESSAGE_OPTIONAL

public static final String MESSAGE_OPTIONAL

See Also:

• Constant Field Values

MESSAGE_SHOWING_RESULTS_FOR_QUERY

public static final String MESSAGE_SHOWING_RESULTS_FOR_QUERY

See Also:

• Constant Field Values

MESSAGE_NO_RESULTS_FOR_QUERY

public static final String MESSAGE_NO_RESULTS_FOR_QUERY

See Also:

• Constant Field Values

MESSAGE_AVAILABLE_COMMANDS

public static final String MESSAGE_AVAILABLE_COMMANDS

See Also:

• Constant Field Values

MESSAGE_CLICK_TO_SHOW_HELP

public static final String MESSAGE_CLICK_TO_SHOW_HELP

See Also:

• Constant Field Values

MESSAGE_PAGE_OUT_OF_RANGE

public static final String MESSAGE_PAGE_OUT_OF_RANGE

See Also:

• Constant Field Values

MESSAGE_CLICK_FOR_NEXT_PAGE

public static final String MESSAGE_CLICK_FOR_NEXT_PAGE

See Also:

• Constant Field Values

MESSAGE_CLICK_FOR_PREVIOUS_PAGE

public static final String MESSAGE_CLICK_FOR_PREVIOUS_PAGE

See Also:

• Constant Field Values

Method Details

defaultCaptionsProvider

public static <C> CaptionProvider<C> defaultCaptionsProvider()

Returns a CaptionProvider for the default messages.

Type Parameters:

C - command sender type

Returns:

default captions provider

See Also:

• captionMessageProvider(CaptionRegistry, ComponentCaptionFormatter)

createNative

@API(status=STABLE,
     since="1.5.0")
public static <C extends Audience>
@NonNull MinecraftHelp<C> createNative(@NonNull String commandPrefix,
 @NonNull CommandManager<C> commandManager)

Constructs a new Minecraft help instance for a sender type which is an Audience.

Type Parameters:

C - sender type extending Audience

Parameters:

commandPrefix - command that was used to trigger the help menu. Used to help insertion generation

commandManager - command manager

Returns:

new MinecraftHelp instance

Since:

1.5.0

create

@API(status=STABLE,
     since="2.0.0")
public static <C> @NonNull MinecraftHelp<C> create(@NonNull String commandPrefix,
 @NonNull CommandManager<C> commandManager,
 @NonNull AudienceProvider<C> audienceProvider)

Constructs a new Minecraft help instance using the default values.

Type Parameters:

C - sender type extending Audience

Parameters:

commandPrefix - command that was used to trigger the help menu. Used to help insertion generation

commandManager - command manager

audienceProvider - mapper from MinecraftHelp to Audience

Returns:

new MinecraftHelp instance

Since:

2.0.0

builder

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ImmutableMinecraftHelp.CommandManagerBuildStage<C> builder()

Returns a new MinecraftHelp builder.

Type Parameters:

C - the command sender type

Returns:

the builder

Since:

2.0.0

commandManager

public abstract @NonNull CommandManager<C> commandManager()

Returns the command manager instance.

Returns:

command manager

audienceProvider

public abstract @NonNull AudienceProvider<C> audienceProvider()

Returns the audience provider that was used to create this instance.

Returns:

audience provider

commandPrefix

@API(status=STABLE,
     since="2.0.0")
public abstract @NonNull String commandPrefix()

Returns the command prefix.

Returns:

command prefix

Since:

2.0.0

helpHandler

@Derived
@API(status=STABLE,
     since="2.0.0")
public @NonNull HelpHandler<C> helpHandler()

Returns the help handler.

Returns:

the help handler

Since:

2.0.0

audience

public @NonNull Audience audience(@NonNull C sender)

Maps a command sender to an Audience

Parameters:

sender - Sender to map

Returns:

Mapped audience

commandFilter

@Default
@API(status=STABLE,
     since="2.0.0")
public @NonNull CommandPredicate<C> commandFilter()

Returns the filter that determines what commands are visible inside the help menu.

The default filter is CommandPredicate.acceptAll().

Returns:

the filter

Since:

2.0.0

descriptionDecorator

@Default
@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftHelp.DescriptionDecorator<C> descriptionDecorator()

Returns the description decorator which turns descriptions into components.

The default decorator is MinecraftHelp.DescriptionDecorator.text().

Returns:

the decorator

Since:

2.0.0

messages

@API(status=STABLE,
     since="2.0.0")
public abstract @NonNull Map<@NonNull String,@NonNull String> messages()

Returns the messages which are used by the default MinecraftHelp.MessageProvider.

Placeholders in the format <name> will be replaced.

Returns:

the messages

Since:

2.0.0

messageProvider

@Default
@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftHelp.MessageProvider<C> messageProvider()

Returns the message provider which is used to retrieve messages from message keys.

The keys are constants in MinecraftHelp.

Returns:

the message provider

Since:

2.0.0

colors

@Default
@API(status=STABLE,
     since="2.0.0")
public @NonNull MinecraftHelp.HelpColors colors()

Returns the colors used for help messages.

Defaults to DEFAULT_HELP_COLORS.

Returns:

the active MinecraftHelp.HelpColors

Since:

2.0.0

headerFooterLength

@Default
@API(status=STABLE,
     since="2.0.0")
public @org.checkerframework.checker.index.qual.NonNegative int headerFooterLength()

Returns the length of the header/footer of help menus.

Defaults to DEFAULT_HEADER_FOOTER_LENGTH.

Returns:

the length

Since:

2.0.0

maxResultsPerPage

@Default
@API(status=STABLE,
     since="2.0.0")
public @org.checkerframework.checker.index.qual.NonNegative int maxResultsPerPage()

Returns the maximum number of help results to display on a page.

Defaults to DEFAULT_MAX_RESULTS_PER_PAGE.

Returns:

the maximum number of results

Since:

2.0.0

messageOrDefault

protected final @NonNull String messageOrDefault(@NonNull String key)

queryCommands

public void queryCommands(@NonNull String rawQuery,
 @NonNull C recipient)

Queries commands and send the results to the recipient. Will respect permissions.

Parameters:

rawQuery - command query (without leading '/', including optional page number)

recipient - recipient

captionMessageProvider

public static <C> MinecraftHelp.MessageProvider<C> captionMessageProvider(CaptionRegistry<C> registry,
 ComponentCaptionFormatter<C> formatter)

Creates a MinecraftHelp.MessageProvider that delegates to the provided CaptionRegistry and ComponentCaptionFormatter. Transforms message keys into captions using Caption.of(String) and the prefix help.minecraft..

Type Parameters:

C - command sender type

Parameters:

registry - caption registry

formatter - caption formatter

Returns:

message provider

See Also:

• defaultCaptionsProvider()

helpColors

public static @NonNull MinecraftHelp.HelpColors helpColors(@NonNull TextColor primary,
 @NonNull TextColor highlight,
 @NonNull TextColor alternateHighlight,
 @NonNull TextColor text,
 @NonNull TextColor accent)

Creates a new MinecraftHelp.HelpColors instance.

Parameters:

primary - the primary color for the color scheme

highlight - the primary color used to highlight commands and queries

alternateHighlight - the secondary color used to highlight commands and queries

text - the color used for description text

accent - the color used for accents and symbols

Returns:

a new MinecraftHelp.HelpColors instance