revxrsal.commands.velocity

Class VelocityVisitors

java.lang.Object

revxrsal.commands.velocity.VelocityVisitors

public final class VelocityVisitors
extends java.lang.Object

Includes modular building blocks for hooking into the Velocity platform.

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

Constructor Summary

Constructors

Constructor and Description
VelocityVisitors()

Method Summary

Modifier and Type	Method and Description
static @NotNull revxrsal.commands.LampVisitor<VelocityCommandActor>	brigadier(@NotNull com.velocitypowered.api.proxy.ProxyServer server) Registers the commands into Velocity as brigadier commands.
static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampVisitor<A>	brigadier(@NotNull com.velocitypowered.api.proxy.ProxyServer server, @NotNull ActorFactory<A> actorFactory) Registers the commands into Velocity as brigadier commands.
static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampVisitor<A>	brigadier(@NotNull com.velocitypowered.api.proxy.ProxyServer server, @NotNull ActorFactory<A> actorFactory, @NotNull revxrsal.commands.brigadier.types.ArgumentTypes<A> argumentTypes) Registers the commands into Velocity as brigadier commands.
static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampVisitor<A>	brigadier(@NotNull VelocityLampConfig<A> config) Registers the commands into Velocity as brigadier commands.
static <A extends VelocityCommandActor> @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 VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	pluginContextParameters(java.lang.Object plugin) Adds dependencies and type resolvers for the given plugin object
static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	velocityExceptionHandler() Handles the default Velocity exceptions
static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	velocityParameterTypes(@NotNull com.velocitypowered.api.proxy.ProxyServer server) Registers the following parameter types: Player
static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	velocityPermissions() Adds support for the CommandPermission annotation
static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A>	velocitySenderResolver() Resolves the sender type CommandSource and Player for parameters that come first in the command.

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityVisitors

public VelocityVisitors()

Method Detail

legacyColorCodes

@NotNull
public static <A extends VelocityCommandActor> @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

velocityExceptionHandler

@NotNull
public static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> velocityExceptionHandler()

Handles the default Velocity exceptions

Type Parameters:

A - The actor type

Returns:

The visitor

velocitySenderResolver

@NotNull
public static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> velocitySenderResolver()

Resolves the sender type CommandSource and Player for parameters that come first in the command.

Type Parameters:

A - The actor type

Returns:

The visitor

velocityParameterTypes

@NotNull
public static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> velocityParameterTypes(@NotNull
                                                                                                                                @NotNull com.velocitypowered.api.proxy.ProxyServer server)

Registers the following parameter types:

• Player

Type Parameters:

A - The actor type

Parameters:

server - The server

Returns:

The visitor

pluginContextParameters

@NotNull
public static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> pluginContextParameters(java.lang.Object plugin)

Adds dependencies and type resolvers for the given plugin object

Type Parameters:

A - The actor type

Parameters:

plugin - Plugin to supply

Returns:

The visitor

velocityPermissions

@NotNull
public static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampBuilderVisitor<A> velocityPermissions()

Adds support for the CommandPermission annotation

Type Parameters:

A - The actor type

Returns:

This visitor

brigadier

@NotNull
public static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampVisitor<A> brigadier(@NotNull
                                                                                                            @NotNull VelocityLampConfig<A> config)

Registers the commands into Velocity as brigadier commands.

Type Parameters:

A - The actor type

Parameters:

config - The VelocityLampConfig object

Returns:

The visitor

brigadier

@NotNull
public static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampVisitor<A> brigadier(@NotNull
                                                                                                            @NotNull com.velocitypowered.api.proxy.ProxyServer server,
                                                                                                            @NotNull
                                                                                                            @NotNull ActorFactory<A> actorFactory,
                                                                                                            @NotNull
                                                                                                            @NotNull revxrsal.commands.brigadier.types.ArgumentTypes<A> argumentTypes)

Registers the commands into Velocity as brigadier commands.

Type Parameters:

A - The actor type

Parameters:

server - The server instance

actorFactory - The actor factory

argumentTypes - The argument type registry

Returns:

The visitor

brigadier

@NotNull
public static <A extends VelocityCommandActor> @NotNull revxrsal.commands.LampVisitor<A> brigadier(@NotNull
                                                                                                            @NotNull com.velocitypowered.api.proxy.ProxyServer server,
                                                                                                            @NotNull
                                                                                                            @NotNull ActorFactory<A> actorFactory)

Registers the commands into Velocity as brigadier commands.

Type Parameters:

A - The actor type

Parameters:

server - The server instance

actorFactory - The actor factory

Returns:

The visitor

brigadier

@NotNull
public static @NotNull revxrsal.commands.LampVisitor<VelocityCommandActor> brigadier(@NotNull
                                                                                              @NotNull com.velocitypowered.api.proxy.ProxyServer server)

Registers the commands into Velocity as brigadier commands.

Parameters:

server - The server instance

Returns:

The visitor