Package cloud.commandframework.paper

Class PaperCommandManager<C>

  • Type Parameters:
    C - Command sender type
    public class PaperCommandManager<C>
extends cloud.commandframework.bukkit.BukkitCommandManager<C>
    Paper command manager that extends BukkitCommandManager

    • Nested Class Summary

      • Nested classes/interfaces inherited from class cloud.commandframework.bukkit.BukkitCommandManager

        cloud.commandframework.bukkit.BukkitCommandManager.BrigadierFailureException, cloud.commandframework.bukkit.BukkitCommandManager.BrigadierFailureReason

      • Nested classes/interfaces inherited from class cloud.commandframework.CommandManager

        cloud.commandframework.CommandManager.ManagerSettings

    • Constructor Summary

      Constructors 
      Constructor Description
      PaperCommandManager​(@NonNull org.bukkit.plugin.Plugin owningPlugin, @NonNull java.util.function.Function<cloud.commandframework.CommandTree<C>,​cloud.commandframework.execution.CommandExecutionCoordinator<C>> commandExecutionCoordinator, @NonNull java.util.function.Function<org.bukkit.command.CommandSender,​C> commandSenderMapper, @NonNull java.util.function.Function<C,​org.bukkit.command.CommandSender> backwardsCommandSenderMapper)
      Construct a new Paper command manager

    • Method Summary

      Modifier and Type Method Description
      void registerAsynchronousCompletions()
      Register asynchronous completions.
      void registerBrigadier()
      Register Brigadier mappings using the native paper events

      • Methods inherited from class cloud.commandframework.bukkit.BukkitCommandManager

        checkBrigadierCompatibility, createDefaultCommandMeta, getBackwardsCommandSenderMapper, getCommandSenderMapper, getOwningPlugin, getSplitAliases, hasPermission, queryCapabilities, queryCapability, setSplitAliases, stripNamespace, taskRecipe

      • Methods inherited from class cloud.commandframework.CommandManager

        argumentBuilder, command, command, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, commandBuilder, executeCommand, flagBuilder, getCaptionRegistry, getCommandHelpHandler, getCommandRegistrationHandler, getCommands, getCommandSuggestionProcessor, getCommandSyntaxFormatter, getCommandTree, getExceptionHandler, getParserRegistry, getSetting, handleException, hasPermission, postprocessContext, preprocessContext, registerCommandPostProcessor, registerCommandPreProcessor, registerDefaultCaptions, registerExceptionHandler, setCaptionRegistry, setCommandRegistrationHandler, setCommandSuggestionProcessor, setCommandSyntaxFormatter, setSetting, suggest

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PaperCommandManager

        public PaperCommandManager​(@NonNull org.bukkit.plugin.Plugin owningPlugin,
                           @NonNull java.util.function.Function<cloud.commandframework.CommandTree<C>,​cloud.commandframework.execution.CommandExecutionCoordinator<C>> commandExecutionCoordinator,
                           @NonNull java.util.function.Function<org.bukkit.command.CommandSender,​C> commandSenderMapper,
                           @NonNull java.util.function.Function<C,​org.bukkit.command.CommandSender> backwardsCommandSenderMapper)
                    throws java.lang.Exception
        Construct a new Paper command manager
        Parameters:
        owningPlugin - Plugin that is constructing the manager
        commandExecutionCoordinator - Coordinator provider
        commandSenderMapper - Function that maps CommandSender to the command sender type
        backwardsCommandSenderMapper - Function that maps the command sender type to CommandSender
        Throws:
        java.lang.Exception - If the construction of the manager fails

    • Method Detail

      • registerBrigadier

        public void registerBrigadier()
                       throws cloud.commandframework.bukkit.BukkitCommandManager.BrigadierFailureException
        Register Brigadier mappings using the native paper events
        Overrides:
        registerBrigadier in class cloud.commandframework.bukkit.BukkitCommandManager<C>
        Throws:
        cloud.commandframework.bukkit.BukkitCommandManager.BrigadierFailureException - Exception thrown if the mappings cannot be registered

      • registerAsynchronousCompletions

        public void registerAsynchronousCompletions()
                                     throws java.lang.IllegalStateException
        Register asynchronous completions. This requires all argument parsers to be thread safe, and it is up to the caller to guarantee that such is the case
        Throws:
        java.lang.IllegalStateException - when the server does not support asynchronous completions.