Package org.incendo.cloud.fabric

Class FabricCommandManager<C,S extends net.minecraft.commands.SharedSuggestionProvider>

java.lang.Object

org.incendo.cloud.CommandManager<C>

org.incendo.cloud.fabric.FabricCommandManager<C,S>

Type Parameters:

C - the manager's sender type

S - the platform sender type

All Implemented Interfaces:

BrigadierManagerHolder<C,S>, CommandBuilderSource<C>, SenderMapperHolder<S,C>, Stateful<RegistrationState>

Direct Known Subclasses:

FabricClientCommandManager, FabricServerCommandManager

public abstract class FabricCommandManager<C,S extends net.minecraft.commands.SharedSuggestionProvider>
extends CommandManager<C>
implements BrigadierManagerHolder<C,S>, SenderMapperHolder<S,C>

A command manager for either the server or client on Fabric.

Commands registered with managers of this type will be registered into a Brigadier command tree.

Where possible, Vanilla argument types are made available in a cloud-friendly format. In some cases, these argument types may only be available for server commands. Mod-provided argument types can be exposed to Cloud as well, by using WrappedBrigadierParser.

Since:

1.5.0

See Also:

• for server commands

Nested Class Summary

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

BrigadierManagerHolder.BrigadierManagerNotPresent

Method Summary

Modifier and Type	Method	Description
final @NonNull CloudBrigadierManager<C,S>	brigadierManager()
final boolean	hasBrigadierManager()
final @NonNull SenderMapper<S,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, hasPermission, 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

Method Details

senderMapper

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

Specified by:

senderMapper in interface SenderMapperHolder<C,S extends net.minecraft.commands.SharedSuggestionProvider>

suggestionFactory

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

Overrides:

suggestionFactory in class CommandManager<C>

hasBrigadierManager

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

This will always return true for FabricCommandManagers.

Specified by:

hasBrigadierManager in interface BrigadierManagerHolder<C,S extends net.minecraft.commands.SharedSuggestionProvider>

Returns:

true

Since:

2.0.0

brigadierManager

@API(status=STABLE,
     since="2.0.0")
public final @NonNull CloudBrigadierManager<C,S> brigadierManager()

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

Specified by:

brigadierManager in interface BrigadierManagerHolder<C,S extends net.minecraft.commands.SharedSuggestionProvider>

Returns: