Package sawfowl.commandpack.api.commands.raw.arguments

Interface RawArgument.Builder<T>

All Superinterfaces:

AbstractBuilder<RawArgument<T>>, Builder<RawArgument<T>,RawArgument.Builder<T>>, ResettableBuilder<RawArgument<T>,RawArgument.Builder<T>>

Enclosing interface:

RawArgument<T>

public static interface RawArgument.Builder<T>
extends AbstractBuilder<RawArgument<T>>, Builder<RawArgument<T>,RawArgument.Builder<T>>

Method Summary

Modifier and Type	Method	Description
RawArgument.Builder<T>	cursor(int value)	Argument number.
RawArgument.Builder<T>	localeTextPath(Object... value)	Path to find the message that there is no matching command argument in the localization configuration.
RawArgument.Builder<T>	optional(boolean value)	Whether the argument is optional.
RawArgument.Builder<T>	optionalForConsole(boolean value)	Is the argument optional for non-players.
RawArgument.Builder<T>	permission(String value)
RawArgument.Builder<T>	result(@NotNull Class<?> clazz, @NotNull RawResultSupplier<?> result)	Setting parameters to get the target object from the command argument.
<C extends CommandTreeNode<C>> RawArgument.Builder<T>	setArgumentType(CommandTreeNode.Argument<C> node)	Specifies the argument type. See the CommandTreeNodeTypes class for available variants. The specified type defines what the player can enter as an argument. This is not controlled by the plugin, but the player will see an error message if the value type is not appropriate.
RawArgument.Builder<T>	treeKey(String value)	The identifier of the argument in the argument tree. It is also displayed to the player above the input line as a hint.
RawArgument.Builder<T>	variants(@NotNull RawCompleterSupplier<Stream<String>> variants)	Set variants for auto-complete commands.

Methods inherited from interface net.kyori.adventure.builder.AbstractBuilder

build

Methods inherited from interface org.spongepowered.api.util.Builder

reset

Method Details

variants

RawArgument.Builder<T> variants(@NotNull
 @NotNull RawCompleterSupplier<Stream<String>> variants)

Set variants for auto-complete commands.

result

RawArgument.Builder<T> result(@NotNull
 @NotNull Class<?> clazz,
 @NotNull
 @NotNull RawResultSupplier<?> result)

Setting parameters to get the target object from the command argument.

optional

RawArgument.Builder<T> optional(boolean value)

Whether the argument is optional.

optionalForConsole

RawArgument.Builder<T> optionalForConsole(boolean value)

Is the argument optional for non-players.

cursor

RawArgument.Builder<T> cursor(int value)

Argument number. The numbering starts with 0.

localeTextPath

RawArgument.Builder<T> localeTextPath(Object... value)

Path to find the message that there is no matching command argument in the localization configuration.

permission

RawArgument.Builder<T> permission(String value)

treeKey

RawArgument.Builder<T> treeKey(String value)

The identifier of the argument in the argument tree.
It is also displayed to the player above the input line as a hint.

setArgumentType

<C extends CommandTreeNode<C>>
RawArgument.Builder<T> setArgumentType(CommandTreeNode.Argument<C> node)

Specifies the argument type.
See the CommandTreeNodeTypes class for available variants.
The specified type defines what the player can enter as an argument.
This is not controlled by the plugin, but the player will see an error message if the value type is not appropriate.