Package org.incendo.cloud.paper

Class PaperCommandManager<C>

java.lang.Object

org.incendo.cloud.CommandManager<C>

org.incendo.cloud.paper.PaperCommandManager<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

BrigadierManagerHolder<C,CommandSourceStack>, PluginHolder, CommandBuilderSource<C>, PluginMetaHolder, SenderMapperHolder<CommandSourceStack,C>, Stateful<RegistrationState>

Direct Known Subclasses:

PaperCommandManager.Bootstrapped

@API(status=EXPERIMENTAL)
public class PaperCommandManager<C>
extends CommandManager<C>
implements SenderMapperHolder<CommandSourceStack,C>, PluginMetaHolder, PluginHolder, BrigadierManagerHolder<C,CommandSourceStack>

A CommandManager implementation for modern Paper API, using CommandSourceStack as the base sender type.

This manager will only function on servers implementing Paper API 1.20.6 or newer.

See Also:

• builder()
• builder(SenderMapper)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PaperCommandManager.Bootstrapped<C>	Variant of PaperCommandManager created at bootstrap time rather than in Plugin.onEnable().
static final class	PaperCommandManager.Builder<C>	First stage builder for PaperCommandManager.
static final class	PaperCommandManager.CoordinatedBuilder<C>	Second stage builder for PaperCommandManager.

Nested classes/interfaces inherited from interface org.incendo.cloud.brigadier.BrigadierManagerHolder

BrigadierManagerHolder.BrigadierManagerNotPresent

Method Summary

Modifier and Type	Method	Description
final @NonNull CloudBrigadierManager<C,? extends CommandSourceStack>	brigadierManager()
static PaperCommandManager.Builder<CommandSourceStack>	builder()	Creates a new PaperCommandManager.Builder using the native Paper CommandSourceStack sender type.
static <C> PaperCommandManager.Builder<C>	builder(SenderMapper<CommandSourceStack,C> senderMapper)	Creates a new PaperCommandManager.Builder for a manager with sender type PaperCommandManager.
final boolean	hasBrigadierManager()
final boolean	hasPermission(@NonNull C sender, @NonNull String permission)
final PluginMeta	owningPluginMeta()	Returns the meta of the plugin that owns the manager.
final @NonNull SenderMapper<CommandSourceStack,C>	senderMapper()

Methods inherited from class org.incendo.cloud.CommandManager

appendSuggestionMapper, capabilities, captionFormatter, captionFormatter, captionRegistry, captionRegistry, command, command, command, commandExecutor, commandRegistrationHandler, commandRegistrationHandler, commands, commandSyntaxFormatter, commandSyntaxFormatter, commandTree, componentBuilder, createDefaultCommandMeta, createHelpHandler, createHelpHandler, decorateBuilder, deleteRootCommand, exceptionController, flagBuilder, hasCapability, helpHandlerFactory, helpHandlerFactory, isCommandRegistrationAllowed, lockRegistration, parameterInjectorRegistry, parserRegistry, postprocessContext, preprocessContext, registerCapability, registerCommandPostProcessor, registerCommandPreProcessor, registerDefaultExceptionHandlers, rootCommands, settings, state, suggestionFactory, suggestionMapper, suggestionMapper, suggestionProcessor, suggestionProcessor, testPermission, transitionIfPossible

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.incendo.cloud.CommandBuilderSource

commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder

Methods inherited from interface org.incendo.cloud.paper.PluginMetaHolder

owningPlugin

Methods inherited from interface org.incendo.cloud.state.Stateful

requireState, transitionOrThrow

Method Details

builder

public static <C> PaperCommandManager.Builder<C> builder(SenderMapper<CommandSourceStack,C> senderMapper)

Creates a new PaperCommandManager.Builder for a manager with sender type PaperCommandManager.

Type Parameters:

C - command sender type

Parameters:

senderMapper - sender mapper

Returns:

builder

builder

public static PaperCommandManager.Builder<CommandSourceStack> builder()

Creates a new PaperCommandManager.Builder using the native Paper CommandSourceStack sender type.

Returns:

builder

hasPermission

public final boolean hasPermission(@NonNull C sender,
 @NonNull String permission)

Specified by:

hasPermission in class CommandManager<C>

senderMapper

public final @NonNull SenderMapper<CommandSourceStack,C> senderMapper()

Specified by:

senderMapper in interface SenderMapperHolder<CommandSourceStack,C>

owningPluginMeta

public final PluginMeta owningPluginMeta()

Description copied from interface: PluginMetaHolder

Returns the meta of the plugin that owns the manager.

Specified by:

owningPluginMeta in interface PluginMetaHolder

Returns:

owning plugin meta

hasBrigadierManager

public final boolean hasBrigadierManager()

Specified by:

hasBrigadierManager in interface BrigadierManagerHolder<C,CommandSourceStack>

brigadierManager

public final @NonNull CloudBrigadierManager<C,? extends CommandSourceStack> brigadierManager()

Specified by:

brigadierManager in interface BrigadierManagerHolder<C,CommandSourceStack>