Package org.incendo.cloud.velocity

Class VelocityCommandManager<C>

java.lang.Object

org.incendo.cloud.CommandManager<C>

org.incendo.cloud.velocity.VelocityCommandManager<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

BrigadierManagerHolder<C,com.velocitypowered.api.command.CommandSource>, CommandBuilderSource<C>, SenderMapperHolder<com.velocitypowered.api.command.CommandSource,C>, Stateful<RegistrationState>

public class VelocityCommandManager<C>
extends CommandManager<C>
implements BrigadierManagerHolder<C,com.velocitypowered.api.command.CommandSource>, SenderMapperHolder<com.velocitypowered.api.command.CommandSource,C>

CommandManager implementation for Velocity.

This can be injected if CloudInjectionModule is registered in the injector. This can be achieved by using Injector.createChildInjector(Module...)

suggestionFactory() has been overridden to map suggestions to TooltipSuggestion. You may use TooltipSuggestion to display tooltips for your suggestions. VelocityBrigadierMessage can be used to make use of Adventure components in the tooltips.

Nested Class Summary

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

BrigadierManagerHolder.BrigadierManagerNotPresent

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARGUMENT_PARSE_FAILURE_PLAYER	Default caption for VelocityCaptionKeys.ARGUMENT_PARSE_FAILURE_PLAYER
static final String	ARGUMENT_PARSE_FAILURE_SERVER	Default caption for VelocityCaptionKeys.ARGUMENT_PARSE_FAILURE_SERVER

Constructor Summary

Constructors

Constructor	Description
VelocityCommandManager(@NonNull com.velocitypowered.api.plugin.PluginContainer plugin, @NonNull com.velocitypowered.api.proxy.ProxyServer proxyServer, @NonNull ExecutionCoordinator<C> commandExecutionCoordinator, @NonNull SenderMapper<com.velocitypowered.api.command.CommandSource,C> senderMapper)	Create a new command manager instance

Method Summary

Modifier and Type	Method	Description
final @NonNull CloudBrigadierManager<C,com.velocitypowered.api.command.CommandSource>	brigadierManager()
final boolean	hasBrigadierManager()
final boolean	hasPermission(@NonNull C sender, @NonNull String permission)
final @NonNull SenderMapper<com.velocitypowered.api.command.CommandSource,C>	senderMapper()
final @NonNull SuggestionFactory<C,? extends TooltipSuggestion>	suggestionFactory()

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, 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.state.Stateful

requireState, transitionOrThrow

Field Details

ARGUMENT_PARSE_FAILURE_PLAYER

public static final String ARGUMENT_PARSE_FAILURE_PLAYER

Default caption for VelocityCaptionKeys.ARGUMENT_PARSE_FAILURE_PLAYER

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_SERVER

public static final String ARGUMENT_PARSE_FAILURE_SERVER

Default caption for VelocityCaptionKeys.ARGUMENT_PARSE_FAILURE_SERVER

See Also:

• Constant Field Values

Constructor Details

VelocityCommandManager

@Inject
public VelocityCommandManager(@NonNull com.velocitypowered.api.plugin.PluginContainer plugin,
 @NonNull com.velocitypowered.api.proxy.ProxyServer proxyServer,
 @NonNull ExecutionCoordinator<C> commandExecutionCoordinator,
 @NonNull SenderMapper<com.velocitypowered.api.command.CommandSource,C> senderMapper)

Create a new command manager instance

Parameters:

plugin - Container for the owning plugin

proxyServer - ProxyServer instance

commandExecutionCoordinator - Coordinator provider

senderMapper - Function that maps CommandSource to the command sender type

Method Details

hasPermission

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

Specified by:

hasPermission in class CommandManager<C>

hasBrigadierManager

@API(status=STABLE,
     since="2.0.0")
public final boolean hasBrigadierManager()

This will always return true for VelocityCommandManagers.

Specified by:

hasBrigadierManager in interface BrigadierManagerHolder<C,com.velocitypowered.api.command.CommandSource>

Returns:

true

Since:

2.0.0

brigadierManager

@API(status=STABLE,
     since="2.0.0")
public final @NonNull CloudBrigadierManager<C,com.velocitypowered.api.command.CommandSource> brigadierManager()

VelocityCommandManagers always use Brigadier for registration, so the aforementioned check is not needed.

Specified by:

brigadierManager in interface BrigadierManagerHolder<C,com.velocitypowered.api.command.CommandSource>

Returns:

Since:

1.2.0

suggestionFactory

public final @NonNull SuggestionFactory<C,? extends TooltipSuggestion> suggestionFactory()

Overrides:

suggestionFactory in class CommandManager<C>

senderMapper

public final @NonNull SenderMapper<com.velocitypowered.api.command.CommandSource,C> senderMapper()

Specified by:

senderMapper in interface SenderMapperHolder<com.velocitypowered.api.command.CommandSource,C>