Package cloud.commandframework.bukkit.parsers.selector

Class MultiplePlayerSelectorArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,MultiplePlayerSelector>

cloud.commandframework.bukkit.parsers.selector.MultiplePlayerSelectorArgument<C>

Type Parameters:

C - sender type

All Implemented Interfaces:

cloud.commandframework.keys.CloudKeyHolder<MultiplePlayerSelector>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>

public final class MultiplePlayerSelectorArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,MultiplePlayerSelector>

Argument type for parsing MultiplePlayerSelector. On Minecraft 1.13+ this argument uses Minecraft's built-in entity selector argument for parsing and suggestions. On prior versions, this argument behaves similarly to PlayerArgument.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MultiplePlayerSelectorArgument.Builder<C>
static final class	MultiplePlayerSelectorArgument.MultiplePlayerSelectorParser<C>

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 MultiplePlayerSelectorArgument.Builder<C>	builder(@NonNull String name)	Create a new MultiplePlayerSelectorArgument.Builder.
static <C> MultiplePlayerSelectorArgument.Builder<C>	newBuilder(@NonNull String name)	Deprecated. prefer builder(String)
static <C> @NonNull MultiplePlayerSelectorArgument<C>	of(@NonNull String name)	Create a new required command argument
static <C> @NonNull MultiplePlayerSelectorArgument<C>	optional(@NonNull String name)	Create a new optional command argument
static <C> @NonNull MultiplePlayerSelectorArgument<C>	optional(@NonNull String name, @NonNull String defaultEntitySelector)	Create a new required command argument with a 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

newBuilder

@API(status=DEPRECATED,
     since="1.8.0")
@Deprecated
public static <C>
MultiplePlayerSelectorArgument.Builder<C> newBuilder(@NonNull String name)

Deprecated.

prefer builder(String)

Create a new builder

Type Parameters:

C - Command sender type

Parameters:

name - Name of the argument

Returns:

Created builder

builder

@API(status=STABLE,
     since="1.8.0")
public static <C>
@NonNull MultiplePlayerSelectorArgument.Builder<C> builder(@NonNull String name)

Create a new MultiplePlayerSelectorArgument.Builder.

Type Parameters:

C - sender type

Parameters:

name - argument name

Returns:

new builder

Since:

1.8.0

of

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

Create a new required command argument

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

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

Create a new optional command argument

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

optional

public static <C>
@NonNull MultiplePlayerSelectorArgument<C> optional(@NonNull String name,
 @NonNull String defaultEntitySelector)

Create a new required command argument with a default value

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

defaultEntitySelector - Default player

Returns:

Created argument