-
- All Implemented Interfaces:
public final class UsageBuilder<T extends Object>
Builder for creating arguments and definitions.
-
-
Constructor Summary
Constructors Constructor Description UsageBuilder()
-
Method Summary
Modifier and Type Method Description final UsageBuilder<T>
description(String description)
Description of arguments and definitions. final UsageBuilder<T>
permission(Permission permission)
Permission to execute. final UsageBuilder<T>
executes(ContextAction<T> action)
What is done. final UsageBuilder<T>
literalArgument(String literal, ContextAction<T> action)
Only the text specified in the literal argument literal is allowed, and the user's own input is not accepted. final UsageBuilder<T>
integerArgument(String name, Integer min, Integer max, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes an Int value. final UsageBuilder<T>
integerArgument(String name, Integer min, Integer max, SuggestionAction<T> suggestion)
An argument that takes an Int value. final UsageBuilder<T>
integerArgument(String name, Integer min, Integer max)
An argument that takes an Int value. final UsageBuilder<T>
integerArgument(String name, Integer min)
An argument that takes an Int value. final UsageBuilder<T>
integerArgument(String name)
An argument that takes an Int value. final UsageBuilder<T>
integerArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes an Int value. final UsageBuilder<T>
longArgument(String name, Long min, Long max, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a Long value. final UsageBuilder<T>
longArgument(String name, Long min, Long max, SuggestionAction<T> suggestion)
An argument that takes a Long value. final UsageBuilder<T>
longArgument(String name, Long min, Long max)
An argument that takes a Long value. final UsageBuilder<T>
longArgument(String name, Long min)
An argument that takes a Long value. final UsageBuilder<T>
longArgument(String name)
An argument that takes a Long value. final UsageBuilder<T>
longArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a long value. final UsageBuilder<T>
doubleArgument(String name, Double min, Double max, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a double value. final UsageBuilder<T>
doubleArgument(String name, Double min, Double max, SuggestionAction<T> suggestion)
An argument that takes a double value. final UsageBuilder<T>
doubleArgument(String name, Double min, Double max)
An argument that takes a double value. final UsageBuilder<T>
doubleArgument(String name, Double min)
An argument that takes a double value. final UsageBuilder<T>
doubleArgument(String name)
An argument that takes a double value. final UsageBuilder<T>
doubleArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a double value. final UsageBuilder<T>
floatArgument(String name, Float min, Float max, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a float value. final UsageBuilder<T>
floatArgument(String name, Float min, Float max, SuggestionAction<T> suggestion)
An argument that takes a float value. final UsageBuilder<T>
floatArgument(String name, Float min, Float max)
An argument that takes a float value. final UsageBuilder<T>
floatArgument(String name, Float min)
An argument that takes a float value. final UsageBuilder<T>
floatArgument(String name)
An argument that takes a float value. final UsageBuilder<T>
floatArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a float value. final UsageBuilder<T>
stringArgument(String name, StringArgument.Type type, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a String value. final UsageBuilder<T>
stringArgument(String name, StringArgument.Type type, SuggestionAction<T> suggestion)
An argument that takes a String value. final UsageBuilder<T>
stringArgument(String name, StringArgument.Type type)
An argument that takes a String value. final UsageBuilder<T>
stringArgument(String name)
An argument that takes a String value. final UsageBuilder<T>
stringArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a String value. final UsageBuilder<T>
selectionArgument(String name, List<String> selections, ContextAction<T> action)
String argument of the selection formula. final UsageBuilder<T>
selectionArgument(String name, String selections, ContextAction<T> action)
String argument of the selection formula. final UsageBuilder<T>
booleanArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a boolean value. final UsageBuilder<T>
entityArgument(String name, Boolean enableSelector, Boolean enableEntities, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes an entity as a value. final UsageBuilder<T>
entityArgument(String name, Boolean enableSelector, Boolean enableEntities, SuggestionAction<T> suggestion)
An argument that takes an entity as a value. final UsageBuilder<T>
entityArgument(String name, Boolean enableSelector, Boolean enableEntities)
An argument that takes an entity as a value. final UsageBuilder<T>
entityArgument(String name, Boolean enableSelector)
An argument that takes an entity as a value. final UsageBuilder<T>
entityArgument(String name)
An argument that takes an entity as a value. final UsageBuilder<T>
locationArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a coordinate. final UsageBuilder<T>
locationArgument(String name, SuggestionAction<T> suggestion)
An argument that takes a coordinate. final UsageBuilder<T>
locationArgument(String name)
An argument that takes a coordinate. final UsageBuilder<T>
vectorArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
Argument that takes a direction. final UsageBuilder<T>
vectorArgument(String name, SuggestionAction<T> suggestion)
Argument that takes a direction. final UsageBuilder<T>
vectorArgument(String name)
Argument that takes a direction. -
-
Method Detail
-
description
final UsageBuilder<T> description(String description)
Description of arguments and definitions.
-
permission
final UsageBuilder<T> permission(Permission permission)
Permission to execute.
-
executes
final UsageBuilder<T> executes(ContextAction<T> action)
What is done.
-
literalArgument
final UsageBuilder<T> literalArgument(String literal, ContextAction<T> action)
Only the text specified in the literal argument literal is allowed, and the user's own input is not accepted.
-
integerArgument
@JvmOverloads() final UsageBuilder<T> integerArgument(String name, Integer min, Integer max, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes an Int value. The lowest value and the highest value can be specified.
-
integerArgument
@JvmOverloads() final UsageBuilder<T> integerArgument(String name, Integer min, Integer max, SuggestionAction<T> suggestion)
An argument that takes an Int value. The lowest value and the highest value can be specified.
-
integerArgument
@JvmOverloads() final UsageBuilder<T> integerArgument(String name, Integer min, Integer max)
An argument that takes an Int value. The lowest value and the highest value can be specified.
-
integerArgument
@JvmOverloads() final UsageBuilder<T> integerArgument(String name, Integer min)
An argument that takes an Int value. The lowest value and the highest value can be specified.
-
integerArgument
@JvmOverloads() final UsageBuilder<T> integerArgument(String name)
An argument that takes an Int value. The lowest value and the highest value can be specified.
-
integerArgument
final UsageBuilder<T> integerArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes an Int value.
-
longArgument
@JvmOverloads() final UsageBuilder<T> longArgument(String name, Long min, Long max, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a Long value. You can specify the lowest and highest values.
-
longArgument
@JvmOverloads() final UsageBuilder<T> longArgument(String name, Long min, Long max, SuggestionAction<T> suggestion)
An argument that takes a Long value. You can specify the lowest and highest values.
-
longArgument
@JvmOverloads() final UsageBuilder<T> longArgument(String name, Long min, Long max)
An argument that takes a Long value. You can specify the lowest and highest values.
-
longArgument
@JvmOverloads() final UsageBuilder<T> longArgument(String name, Long min)
An argument that takes a Long value. You can specify the lowest and highest values.
-
longArgument
@JvmOverloads() final UsageBuilder<T> longArgument(String name)
An argument that takes a Long value. You can specify the lowest and highest values.
-
longArgument
final UsageBuilder<T> longArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a long value.
-
doubleArgument
@JvmOverloads() final UsageBuilder<T> doubleArgument(String name, Double min, Double max, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a double value. You can specify the lowest and highest values.
-
doubleArgument
@JvmOverloads() final UsageBuilder<T> doubleArgument(String name, Double min, Double max, SuggestionAction<T> suggestion)
An argument that takes a double value. You can specify the lowest and highest values.
-
doubleArgument
@JvmOverloads() final UsageBuilder<T> doubleArgument(String name, Double min, Double max)
An argument that takes a double value. You can specify the lowest and highest values.
-
doubleArgument
@JvmOverloads() final UsageBuilder<T> doubleArgument(String name, Double min)
An argument that takes a double value. You can specify the lowest and highest values.
-
doubleArgument
@JvmOverloads() final UsageBuilder<T> doubleArgument(String name)
An argument that takes a double value. You can specify the lowest and highest values.
-
doubleArgument
final UsageBuilder<T> doubleArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a double value.
-
floatArgument
@JvmOverloads() final UsageBuilder<T> floatArgument(String name, Float min, Float max, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a float value. You can specify the lowest and highest values.
-
floatArgument
@JvmOverloads() final UsageBuilder<T> floatArgument(String name, Float min, Float max, SuggestionAction<T> suggestion)
An argument that takes a float value. You can specify the lowest and highest values.
-
floatArgument
@JvmOverloads() final UsageBuilder<T> floatArgument(String name, Float min, Float max)
An argument that takes a float value. You can specify the lowest and highest values.
-
floatArgument
@JvmOverloads() final UsageBuilder<T> floatArgument(String name, Float min)
An argument that takes a float value. You can specify the lowest and highest values.
-
floatArgument
@JvmOverloads() final UsageBuilder<T> floatArgument(String name)
An argument that takes a float value. You can specify the lowest and highest values.
-
floatArgument
final UsageBuilder<T> floatArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a float value.
-
stringArgument
@JvmOverloads() final UsageBuilder<T> stringArgument(String name, StringArgument.Type type, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a String value. Type can be specified.
-
stringArgument
@JvmOverloads() final UsageBuilder<T> stringArgument(String name, StringArgument.Type type, SuggestionAction<T> suggestion)
An argument that takes a String value. Type can be specified.
-
stringArgument
@JvmOverloads() final UsageBuilder<T> stringArgument(String name, StringArgument.Type type)
An argument that takes a String value. Type can be specified.
-
stringArgument
@JvmOverloads() final UsageBuilder<T> stringArgument(String name)
An argument that takes a String value. Type can be specified.
-
stringArgument
final UsageBuilder<T> stringArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a String value.
-
selectionArgument
final UsageBuilder<T> selectionArgument(String name, List<String> selections, ContextAction<T> action)
String argument of the selection formula.
-
selectionArgument
final UsageBuilder<T> selectionArgument(String name, String selections, ContextAction<T> action)
String argument of the selection formula.
-
booleanArgument
final UsageBuilder<T> booleanArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a boolean value.
-
entityArgument
@JvmOverloads() final UsageBuilder<T> entityArgument(String name, Boolean enableSelector, Boolean enableEntities, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes an entity as a value.
@a[distance=5]
AnPlayerName
@r
-
entityArgument
@JvmOverloads() final UsageBuilder<T> entityArgument(String name, Boolean enableSelector, Boolean enableEntities, SuggestionAction<T> suggestion)
An argument that takes an entity as a value.
@a[distance=5]
AnPlayerName
@r
-
entityArgument
@JvmOverloads() final UsageBuilder<T> entityArgument(String name, Boolean enableSelector, Boolean enableEntities)
An argument that takes an entity as a value.
@a[distance=5]
AnPlayerName
@r
-
entityArgument
@JvmOverloads() final UsageBuilder<T> entityArgument(String name, Boolean enableSelector)
An argument that takes an entity as a value.
@a[distance=5]
AnPlayerName
@r
-
entityArgument
@JvmOverloads() final UsageBuilder<T> entityArgument(String name)
An argument that takes an entity as a value.
@a[distance=5]
AnPlayerName
@r
-
locationArgument
@JvmOverloads() final UsageBuilder<T> locationArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
An argument that takes a coordinate.
10 235 66
~ ~10 ~-5
~ 10 ^200
-
locationArgument
@JvmOverloads() final UsageBuilder<T> locationArgument(String name, SuggestionAction<T> suggestion)
An argument that takes a coordinate.
10 235 66
~ ~10 ~-5
~ 10 ^200
-
locationArgument
@JvmOverloads() final UsageBuilder<T> locationArgument(String name)
An argument that takes a coordinate.
10 235 66
~ ~10 ~-5
~ 10 ^200
-
vectorArgument
@JvmOverloads() final UsageBuilder<T> vectorArgument(String name, SuggestionAction<T> suggestion, ContextAction<T> action)
Argument that takes a direction.
5 3 1
^ ^ ^
~ ~5 ~
-
vectorArgument
@JvmOverloads() final UsageBuilder<T> vectorArgument(String name, SuggestionAction<T> suggestion)
Argument that takes a direction.
5 3 1
^ ^ ^
~ ~5 ~
-
vectorArgument
@JvmOverloads() final UsageBuilder<T> vectorArgument(String name)
Argument that takes a direction.
5 3 1
^ ^ ^
~ ~5 ~
-
-
-
-