revxrsal.commands.bukkit

Class BukkitVisitors

java.lang.Object

revxrsal.commands.bukkit.BukkitVisitors

public final class BukkitVisitors
extends java.lang.Object

Includes modular building blocks for hooking into the Bukkit platform.

Accept individual functions using Lamp.Builder#accept(LampBuilderVisitor)

Constructor Summary

Constructors

Constructor and Description
BukkitVisitors()

Method Summary

Modifier and Type	Method and Description
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	asyncTabCompletion(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull ActorFactory<A> actorFactory) Enables asynchronous tab completions (Paper only)
static @NotNull revxrsal.commands.LampBuilderVisitor<BukkitCommandActor>	brigadier(@NotNull org.bukkit.plugin.java.JavaPlugin plugin) Adds a registration hook that injects Lamp commands into Bukkit's Brigadier.
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	brigadier(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull revxrsal.commands.brigadier.types.ArgumentTypes<? super A> argumentTypes, @NotNull ActorFactory<A> actorFactory) Adds a registration hook that injects Lamp commands into Bukkit's Brigadier.
static @NotNull revxrsal.commands.LampBuilderVisitor<BukkitCommandActor>	brigadier(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull revxrsal.commands.brigadier.types.ArgumentTypes<? super BukkitCommandActor> argumentTypes) Adds a registration hook that injects Lamp commands into Bukkit's Brigadier.
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	bukkitExceptionHandler() Handles the default Bukkit exceptions
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	bukkitParameterTypes() Registers the following parameter types: Player OfflinePlayer World EntitySelector
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	bukkitParameterTypes(boolean brigadierEnabled) Registers the following parameter types: Player OfflinePlayer World EntitySelector
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	bukkitPermissions() Adds support for the CommandPermission annotation
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	bukkitSenderResolver() Resolves the sender type CommandSender, Player and ConsoleCommandSender for parameters that come first in the command.
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	legacyColorCodes() Makes the default format for CommandActor.reply(String) and CommandActor.error(String) take the legacy ampersand ChatColor-coded format
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	pluginContextParameters(org.bukkit.plugin.java.JavaPlugin plugin) Adds Plugin dependencies and type resolvers
static @NotNull revxrsal.commands.LampBuilderVisitor<BukkitCommandActor>	registrationHooks(@NotNull org.bukkit.plugin.java.JavaPlugin plugin) Adds a registration hook that injects Lamp commands into Bukkit
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	registrationHooks(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull ActorFactory<A> actorFactory)
static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	registrationHooks(@NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull ActorFactory<A> actorFactory, @NotNull java.lang.String defaultFallbackPrefix) Adds a registration hook that injects Lamp commands into Bukkit.

Methods inherited from class java.lang.Object

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

Constructor Detail

BukkitVisitors

public BukkitVisitors()

Method Detail

legacyColorCodes

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> legacyColorCodes()

Makes the default format for CommandActor.reply(String) and CommandActor.error(String) take the legacy ampersand ChatColor-coded format

Type Parameters:

A - The actor type

Returns:

The visitor

bukkitExceptionHandler

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> bukkitExceptionHandler()

Handles the default Bukkit exceptions

Type Parameters:

A - The actor type

Returns:

The visitor

bukkitSenderResolver

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> bukkitSenderResolver()

Resolves the sender type CommandSender, Player and ConsoleCommandSender for parameters that come first in the command.

Type Parameters:

A - The actor type

Returns:

The visitor

bukkitParameterTypes

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> bukkitParameterTypes()

Registers the following parameter types:

• Player
• OfflinePlayer
• World
• EntitySelector

Type Parameters:

A - The actor type

Returns:

The visitor

bukkitParameterTypes

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> bukkitParameterTypes(boolean brigadierEnabled)

Registers the following parameter types:

• Player
• OfflinePlayer
• World
• EntitySelector

Type Parameters:

A - The actor type

Returns:

The visitor

registrationHooks

@NotNull
public static @NotNull revxrsal.commands.LampBuilderVisitor<BukkitCommandActor> registrationHooks(@NotNull
                                                                                                           @NotNull org.bukkit.plugin.java.JavaPlugin plugin)

Adds a registration hook that injects Lamp commands into Bukkit

Parameters:

plugin - The plugin instance to bind commands to

Returns:

The visitor

registrationHooks

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> registrationHooks(@NotNull
                                                                                                                         @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
                                                                                                                         @NotNull
                                                                                                                         @NotNull ActorFactory<A> actorFactory)

registrationHooks

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> registrationHooks(@NotNull
                                                                                                                         @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
                                                                                                                         @NotNull
                                                                                                                         @NotNull ActorFactory<A> actorFactory,
                                                                                                                         @NotNull
                                                                                                                         @NotNull java.lang.String defaultFallbackPrefix)

Adds a registration hook that injects Lamp commands into Bukkit.

This function allows to specify a custom ActorFactory to use custom implementations of BukkitCommandActor

Parameters:

plugin - The plugin instance to bind commands to

actorFactory - The actor factory. This allows for creating custom BukkitCommandActor implementations

defaultFallbackPrefix - The default fallback prefix to use (which Bukkit uses to prevent conflicts). Note that this can be overridden on a per-command basis using @FallbackPrefix

Returns:

The visitor

pluginContextParameters

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> pluginContextParameters(org.bukkit.plugin.java.JavaPlugin plugin)

Adds Plugin dependencies and type resolvers

Type Parameters:

A - The actor type

Parameters:

plugin - Plugin to supply

Returns:

The visitor

bukkitPermissions

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> bukkitPermissions()

Adds support for the CommandPermission annotation

Type Parameters:

A - The actor type

Returns:

This visitor

brigadier

@NotNull
public static @NotNull revxrsal.commands.LampBuilderVisitor<BukkitCommandActor> brigadier(@NotNull
                                                                                                   @NotNull org.bukkit.plugin.java.JavaPlugin plugin)

Adds a registration hook that injects Lamp commands into Bukkit's Brigadier.

This function allows to specify a custom ActorFactory to use custom implementations of BukkitCommandActor

Parameters:

plugin - The plugin instance to bind commands to

Returns:

The visitor

brigadier

@NotNull
public static @NotNull revxrsal.commands.LampBuilderVisitor<BukkitCommandActor> brigadier(@NotNull
                                                                                                   @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
                                                                                                   @NotNull
                                                                                                   @NotNull revxrsal.commands.brigadier.types.ArgumentTypes<? super BukkitCommandActor> argumentTypes)

Adds a registration hook that injects Lamp commands into Bukkit's Brigadier.

Parameters:

argumentTypes - The argument types registry. See BukkitArgumentTypes for Bukkit types

plugin - The plugin instance to bind commands to

Returns:

The visitor

brigadier

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> brigadier(@NotNull
                                                                                                                 @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
                                                                                                                 @NotNull
                                                                                                                 @NotNull revxrsal.commands.brigadier.types.ArgumentTypes<? super A> argumentTypes,
                                                                                                                 @NotNull
                                                                                                                 @NotNull ActorFactory<A> actorFactory)

Adds a registration hook that injects Lamp commands into Bukkit's Brigadier.

This function allows to specify a custom ActorFactory to use custom implementations of BukkitCommandActor

Parameters:

plugin - The plugin instance to bind commands to

argumentTypes - The argument types registry. See BukkitArgumentTypes for Bukkit types

actorFactory - The actor factory. This allows for creating custom BukkitCommandActor implementations

Returns:

The visitor

asyncTabCompletion

@NotNull
public static <A extends BukkitCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> asyncTabCompletion(@NotNull
                                                                                                                          @NotNull org.bukkit.plugin.java.JavaPlugin plugin,
                                                                                                                          @NotNull
                                                                                                                          @NotNull ActorFactory<A> actorFactory)

Enables asynchronous tab completions (Paper only)

Type Parameters:

A - The actor type

Parameters:

plugin - Plugin to register asynchronous tab completions for

actorFactory - The actor factory

Returns:

A LampBuilderVisitor