Package io.papermc.paper.command.brigadier

Enum Class CommandRegistrationFlag

java.lang.Object

java.lang.Enum<CommandRegistrationFlag>

io.papermc.paper.command.brigadier.CommandRegistrationFlag

All Implemented Interfaces:

Serializable, Comparable<CommandRegistrationFlag>, Constable

@Internal
public enum CommandRegistrationFlag
extends Enum<CommandRegistrationFlag>

A CommandRegistrationFlag is used in Commands registration for internal purposes.

A command library may use this to achieve more specific customization on how their commands are registered.

API Note:

Stability of these flags is not promised! This api is not intended for public use.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLATTEN_ALIASES	Deprecated. This is the default behavior now.
RELOADABLE	Indicates that this command does not need to be re-registered during registry reloads.
SERVER_ONLY	Deprecated, for removal: This API element is subject to removal in a future version. Removed as it causes a warning to appear on the client now.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RELOADABLE

public static final CommandRegistrationFlag RELOADABLE

Indicates that this command does not need to be re-registered during registry reloads. It is automatically preserved and copied to the new command dispatcher.

FLATTEN_ALIASES

@Deprecated(since="1.21.4")
public static final CommandRegistrationFlag FLATTEN_ALIASES

Deprecated.

This is the default behavior now.

SERVER_ONLY

@Deprecated(since="1.21.6",
            forRemoval=true)
public static final CommandRegistrationFlag SERVER_ONLY

Deprecated, for removal: This API element is subject to removal in a future version.

Removed as it causes a warning to appear on the client now.

Method Details

values

public static CommandRegistrationFlag[] values()

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

Returns:

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

valueOf

public static CommandRegistrationFlag valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null