Package cloud.commandframework.fabric.argument

Class NamedColorArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,net.minecraft.ChatFormatting>

cloud.commandframework.fabric.argument.NamedColorArgument<C>

Type Parameters:

C - the sender type

All Implemented Interfaces:

cloud.commandframework.keys.CloudKeyHolder<net.minecraft.ChatFormatting>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>

public final class NamedColorArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,net.minecraft.ChatFormatting>

An argument for named colors in the ChatFormatting enum.

Since:

1.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NamedColorArgument.Builder<C>	Builder for NamedColorArgument.

Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

cloud.commandframework.arguments.CommandArgument.TypedBuilder<C extends Object,T extends Object,B extends cloud.commandframework.arguments.CommandArgument.Builder<C,T>>

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull NamedColorArgument.Builder<C>	builder(@NonNull String name)	Create a new NamedColorArgument.Builder.
static <C> @NonNull NamedColorArgument<C>	of(@NonNull String name)	Create a new required NamedColorArgument.
static <C> @NonNull NamedColorArgument<C>	optional(@NonNull String name)	Create a new optional NamedColorArgument.
static <C> @NonNull NamedColorArgument<C>	optional(@NonNull String name, @NonNull net.minecraft.ChatFormatting defaultColor)	Create a new optional NamedColorArgument with the specified default value.

Methods inherited from class cloud.commandframework.arguments.CommandArgument

addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static <C>
@NonNull NamedColorArgument.Builder<C> builder(@NonNull String name)

Create a new NamedColorArgument.Builder.

Type Parameters:

C - Command sender type

Parameters:

name - Name of the component

Returns:

Created builder

Since:

1.5.0

of

public static <C> @NonNull NamedColorArgument<C> of(@NonNull String name)

Create a new required NamedColorArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Component name

Returns:

Created component

Since:

1.5.0

optional

public static <C> @NonNull NamedColorArgument<C> optional(@NonNull String name)

Create a new optional NamedColorArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Component name

Returns:

Created component

Since:

1.5.0

optional

public static <C> @NonNull NamedColorArgument<C> optional(@NonNull String name,
 @NonNull net.minecraft.ChatFormatting defaultColor)

Create a new optional NamedColorArgument with the specified default value.

Type Parameters:

C - Command sender type

Parameters:

name - Component name

defaultColor - Default colour, must be a color

Returns:

Created component

Since:

1.5.0