Package cloud.commandframework.fabric.argument

Class ResourceLocationArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,net.minecraft.resources.ResourceLocation>

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

Type Parameters:

C - the sender type

All Implemented Interfaces:

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

public final class ResourceLocationArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,net.minecraft.resources.ResourceLocation>

An argument parsing a ResourceLocation.

Since:

1.5.0

Nested Class Summary

Nested Classes

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

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 ResourceLocationArgument.Builder<C>	builder(@NonNull String name)	Create a new ResourceLocationArgument.Builder.
static <C> @NonNull ResourceLocationArgument<C>	of(@NonNull String name)	Create a new required ResourceLocationArgument.
static <C> @NonNull ResourceLocationArgument<C>	optional(@NonNull String name)	Create a new optional ResourceLocationArgument.
static <C> @NonNull ResourceLocationArgument<C>	optional(@NonNull String name, @NonNull net.minecraft.resources.ResourceLocation defaultValue)	Create a new optional ResourceLocationArgument 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 ResourceLocationArgument.Builder<C> builder(@NonNull String name)

Create a new ResourceLocationArgument.Builder.

Type Parameters:

C - Command sender type

Parameters:

name - Name of the argument

Returns:

Created builder

Since:

1.5.0

of

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

Create a new required ResourceLocationArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Component name

Returns:

Created argument

Since:

1.5.0

optional

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

Create a new optional ResourceLocationArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Component name

Returns:

Created argument

Since:

1.5.0

optional

public static <C>
@NonNull ResourceLocationArgument<C> optional(@NonNull String name,
 @NonNull net.minecraft.resources.ResourceLocation defaultValue)

Create a new optional ResourceLocationArgument with the specified default value.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultValue - Default value

Returns:

Created argument

Since:

1.5.0