Package cloud.commandframework.bukkit

Enum CloudBukkitCapabilities

java.lang.Object

java.lang.Enum<CloudBukkitCapabilities>

cloud.commandframework.bukkit.CloudBukkitCapabilities

All Implemented Interfaces:

cloud.commandframework.CloudCapability, Serializable, Comparable<CloudBukkitCapabilities>

public enum CloudBukkitCapabilities
extends Enum<CloudBukkitCapabilities>
implements cloud.commandframework.CloudCapability

Capabilities for the Bukkit module

Nested Class Summary

Nested classes/interfaces inherited from interface cloud.commandframework.CloudCapability

cloud.commandframework.CloudCapability.CloudCapabilityMissingException, cloud.commandframework.CloudCapability.StandardCapabilities

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASYNCHRONOUS_COMPLETION	Whether asynchronous command completions are supported through the Paper API.
BRIGADIER	Whether Brigadier is present in the current environment.
COMMODORE_BRIGADIER	Whether support for Brigadier command registration is available through Commodore (BukkitCommandManager.registerBrigadier()).
NATIVE_BRIGADIER	Whether support for native Brigadier command registration is available through the Paper API (PaperCommandManager#registerBrigadier from cloud-paper).

Method Summary

Modifier and Type	Method	Description
@NonNull String	toString()
static CloudBukkitCapabilities	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CloudBukkitCapabilities[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BRIGADIER

public static final CloudBukkitCapabilities BRIGADIER

Whether Brigadier is present in the current environment. Certain parser types require this, and are able to work even if a capability for Brigadier command registration is not present (as long as this capability is present).

NATIVE_BRIGADIER

public static final CloudBukkitCapabilities NATIVE_BRIGADIER

Whether support for native Brigadier command registration is available through the Paper API (PaperCommandManager#registerBrigadier from cloud-paper).

COMMODORE_BRIGADIER

public static final CloudBukkitCapabilities COMMODORE_BRIGADIER

Whether support for Brigadier command registration is available through Commodore (BukkitCommandManager.registerBrigadier()).

Note: As of 1.19.2, Commodore simply delegates to the same Paper API as cloud is capable of using directly, doing nothing on non-Paper Bukkit implementations. As such, this capability will not be present in 1.19.2+ environments. Users should prefer using PaperCommandManager from cloud-paper and checking for NATIVE_BRIGADIER.

ASYNCHRONOUS_COMPLETION

public static final CloudBukkitCapabilities ASYNCHRONOUS_COMPLETION

Whether asynchronous command completions are supported through the Paper API.

Method Details

values

public static CloudBukkitCapabilities[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CloudBukkitCapabilities valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public @NonNull String toString()

Specified by:

toString in interface cloud.commandframework.CloudCapability

Overrides:

toString in class Enum<CloudBukkitCapabilities>