Index

A C D E G H I L M N O P Q R S T V W
All Classes|All Packages|Constant Field Values|Deprecated API

A

accent() - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp.HelpColors

Get the configured accent color

alternateHighlight() - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp.HelpColors

Get the configured alternate highlight color

apply(C) - Method in interface cloud.commandframework.minecraft.extras.AudienceProvider

Convert a command sender to an Audience

apply(CommandManager<C>, Function<C, Audience>) - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Register the exception handlers in the manager

ARGUMENT_PARSING - Enum constant in enum cloud.commandframework.minecraft.extras.MinecraftExceptionHandler.ExceptionType

An argument failed to parse (ArgumentParseException)

AudienceProvider<C> - Interface in cloud.commandframework.minecraft.extras

Function that maps the command sender type to an adventure Audience

C

cloud.commandframework.minecraft.extras - package cloud.commandframework.minecraft.extras

Minecraft extras

COMMAND_EXECUTION - Enum constant in enum cloud.commandframework.minecraft.extras.MinecraftExceptionHandler.ExceptionType

A command handler had an exception (CommandExecutionException)

commandFilter(Predicate<Command<C>>) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Sets a filter for what commands are visible inside the help menu.

createNative(String, CommandManager<C>) - Static method in class cloud.commandframework.minecraft.extras.MinecraftHelp

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

D

DEFAULT_ARGUMENT_PARSING_FUNCTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Default component builder for ArgumentParseException

DEFAULT_COMMAND_EXECUTION_FUNCTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Default component builder for CommandExecutionException

DEFAULT_HEADER_FOOTER_LENGTH - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

DEFAULT_HELP_COLORS - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

The default color scheme for MinecraftHelp

DEFAULT_INVALID_SENDER_FUNCTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Default component builder for InvalidCommandSenderException

DEFAULT_INVALID_SYNTAX_FUNCTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Default component builder for InvalidSyntaxException

DEFAULT_MAX_RESULTS_PER_PAGE - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

DEFAULT_NO_PERMISSION_FUNCTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Default component builder for NoPermissionException

DESCRIPTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftExtrasMetaKeys

A component short description.

descriptionDecorator(Function<String, Component>) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Set the description decorator which will turn command and argument description strings into components.

E

empty() - Static method in class cloud.commandframework.minecraft.extras.RichDescription

Get an empty description.

G

getAudience(C) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Map a command sender to an Audience

getAudienceProvider() - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Get the audience provider that was used to create this instance

getCommandManager() - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Get the command manager instance

getContents() - Method in class cloud.commandframework.minecraft.extras.RichDescription

Get the contents of this description.

getDescription() - Method in class cloud.commandframework.minecraft.extras.RichDescription

Deprecated.

to discourage use. A plain serialization is a somewhat expensive and lossy operation, use RichDescription.getContents() instead.

getHelpColors() - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Get the colors used for help messages.

H

highlight() - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp.HelpColors

Get the configured highlight color

I

INVALID_SENDER - Enum constant in enum cloud.commandframework.minecraft.extras.MinecraftExceptionHandler.ExceptionType

The sender is not of the right type (InvalidCommandSenderException)

INVALID_SYNTAX - Enum constant in enum cloud.commandframework.minecraft.extras.MinecraftExceptionHandler.ExceptionType

The input does not correspond to any known command (InvalidSyntaxException)

isEmpty() - Method in class cloud.commandframework.minecraft.extras.RichDescription

L

LONG_DESCRIPTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftExtrasMetaKeys

A component long description.

M

MESSAGE_ARGUMENTS - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_AVAILABLE_COMMANDS - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_CLICK_FOR_NEXT_PAGE - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_CLICK_FOR_PREVIOUS_PAGE - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_CLICK_TO_SHOW_HELP - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_COMMAND - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_DESCRIPTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_HELP_TITLE - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_NO_DESCRIPTION - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_NO_RESULTS_FOR_QUERY - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_OPTIONAL - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_PAGE_OUT_OF_RANGE - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

MESSAGE_SHOWING_RESULTS_FOR_QUERY - Static variable in class cloud.commandframework.minecraft.extras.MinecraftHelp

messageProvider(MinecraftHelp.MessageProvider<C>) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Set a custom message provider function to be used for getting messages from keys.

MinecraftExceptionHandler<C> - Class in cloud.commandframework.minecraft.extras

Exception handler that sends Component to the sender.

MinecraftExceptionHandler() - Constructor for class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

MinecraftExceptionHandler.ExceptionType - Enum in cloud.commandframework.minecraft.extras

Exception types

MinecraftExtrasMetaKeys - Class in cloud.commandframework.minecraft.extras

Extra command metadata for providing rich text.

MinecraftHelp<C> - Class in cloud.commandframework.minecraft.extras

Opinionated extension of CommandHelpHandler for Minecraft

MinecraftHelp(String, AudienceProvider<C>, CommandManager<C>) - Constructor for class cloud.commandframework.minecraft.extras.MinecraftHelp

Construct a new Minecraft help instance.

MinecraftHelp.HelpColors - Class in cloud.commandframework.minecraft.extras

Class for holding the TextColors used for help menus

MinecraftHelp.MessageProvider<C> - Interface in cloud.commandframework.minecraft.extras

N

nativeAudience() - Static method in interface cloud.commandframework.minecraft.extras.AudienceProvider

Get an audience provider for sender types which are already an Audience.

NO_PERMISSION - Enum constant in enum cloud.commandframework.minecraft.extras.MinecraftExceptionHandler.ExceptionType

The sender does not have permission to execute the command (NoPermissionException)

O

of(String) - Static method in class cloud.commandframework.minecraft.extras.TextColorArgument

Create a new required TextColor argument

of(ComponentLike) - Static method in class cloud.commandframework.minecraft.extras.RichDescription

Create a new rich description from the provided component.

of(TextColor, TextColor, TextColor, TextColor, TextColor) - Static method in class cloud.commandframework.minecraft.extras.MinecraftHelp.HelpColors

Create a new MinecraftHelp.HelpColors instance

optional(String) - Static method in class cloud.commandframework.minecraft.extras.TextColorArgument

Create a new optional TextColor argument

optionalWithDefault(String, String) - Static method in class cloud.commandframework.minecraft.extras.TextColorArgument

Create a new optional TextColor argument

P

parse(CommandContext<C>, Queue<String>) - Method in class cloud.commandframework.minecraft.extras.TextColorArgument.TextColorParser

primary() - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp.HelpColors

Get the configured primary color

provide(C, String, String...) - Method in interface cloud.commandframework.minecraft.extras.MinecraftHelp.MessageProvider

Creates a component from a command sender, key, and arguments

Q

queryCommands(String, C) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Query commands and send the results to the recipient.

R

RichDescription - Class in cloud.commandframework.minecraft.extras

An argument description implementation that uses Adventure components.

S

setHeaderFooterLength(int) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Set the length of the header/footer of help menus

setHelpColors(MinecraftHelp.HelpColors) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Set the colors to use for help messages.

setMaxResultsPerPage(int) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Set the maximum number of help results to display on one page

setMessage(String, String) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Configure a message

setMessageProvider(BiFunction<C, String, String>) - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp

Set a custom message provider function to be used for getting messages from keys.

suggestions(CommandContext<C>, String) - Method in class cloud.commandframework.minecraft.extras.TextColorArgument.TextColorParser

T

text() - Method in class cloud.commandframework.minecraft.extras.MinecraftHelp.HelpColors

Get the configured text color

TextColorArgument<C> - Class in cloud.commandframework.minecraft.extras

Parser for color codes.

TextColorArgument.TextColorParser<C> - Class in cloud.commandframework.minecraft.extras

TextColorParser() - Constructor for class cloud.commandframework.minecraft.extras.TextColorArgument.TextColorParser

translatable(String) - Static method in class cloud.commandframework.minecraft.extras.RichDescription

Create a rich description pointing to a translation key.

translatable(String, ComponentLike...) - Static method in class cloud.commandframework.minecraft.extras.RichDescription

Create a rich description pointing to a translation key.

V

valueOf(String) - Static method in enum cloud.commandframework.minecraft.extras.MinecraftExceptionHandler.ExceptionType

Returns the enum constant of this type with the specified name.

values() - Static method in enum cloud.commandframework.minecraft.extras.MinecraftExceptionHandler.ExceptionType

Returns an array containing the constants of this enum type, in the order they are declared.

W

withArgumentParsingHandler() - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Use the default argument parsing handler

withCommandExecutionHandler() - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Use the default CommandExecutionException handler

withDecorator(Function<Component, Component>) - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Specify a decorator that acts on a component before it's sent to the sender

withDefaultHandlers() - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Use all of the default exception handlers

withHandler(MinecraftExceptionHandler.ExceptionType, BiFunction<C, Exception, Component>) - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Specify an exception handler

withHandler(MinecraftExceptionHandler.ExceptionType, Function<Exception, Component>) - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Specify an exception handler

withInvalidSenderHandler() - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Use the default invalid sender handler

withInvalidSyntaxHandler() - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Use the default invalid syntax handler

withNoPermissionHandler() - Method in class cloud.commandframework.minecraft.extras.MinecraftExceptionHandler

Use the default no permission handler

A C D E G H I L M N O P Q R S T V W
All Classes|All Packages|Constant Field Values|Deprecated API