T - the sender type@NonnullByDefault -public static interface Commands.CommandBuilder<T extends CommandSender>-
Commands.FunctionalCommand| Modifier and Type | -Method and Description | -
|---|---|
default Commands.CommandBuilder<T> |
-assertArgument(int index,
- Predicate<String> test)
-Tests a given argument with the provided predicate.
- |
-
Commands.CommandBuilder<T> |
-assertArgument(int index,
- Predicate<String> test,
- String failureMessage)
-Tests a given argument with the provided predicate.
- |
-
default Commands.CommandBuilder<ConsoleCommandSender> |
-assertConsole()
-Asserts that the sender is instance of ConsoleCommandSender, and sends them the default failure message if
- they're not.
- |
-
Commands.CommandBuilder<ConsoleCommandSender> |
-assertConsole(String failureMessage)
-Asserts that the sender is instance of ConsoleCommandSender, and sends them the failure message if they're not
- |
-
default Commands.CommandBuilder<T> |
-assertOp()
-Asserts that the sender is op, and sends them the default failure message if they're not.
- |
-
Commands.CommandBuilder<T> |
-assertOp(String failureMessage)
-Asserts that the sender is op, and sends them the failure message if they don't have permission
- |
-
default Commands.CommandBuilder<T> |
-assertPermission(String permission)
-Asserts that the sender has the specified permission, and sends them the default failure message
- if they don't have permission.
- |
-
Commands.CommandBuilder<T> |
-assertPermission(String permission,
- String failureMessage)
-Asserts that the sender has the specified permission, and sends them the failure message if they
- don't have permission.
- |
-
default Commands.CommandBuilder<Player> |
-assertPlayer()
-Asserts that the sender is instance of Player, and sends them the default failure message if they're not.
- |
-
Commands.CommandBuilder<Player> |
-assertPlayer(String failureMessage)
-Asserts that the sender is instance of Player, and sends them the failure message if they're not
- |
-
default Commands.CommandBuilder<T> |
-assertSender(Predicate<T> test)
-Tests the sender with the provided predicate.
- |
-
Commands.CommandBuilder<T> |
-assertSender(Predicate<T> test,
- String failureMessage)
-Tests the sender with the provided predicate.
- |
-
default Commands.CommandBuilder<T> |
-assertUsage(String usage)
-Asserts that the arguments match the given usage string.
- |
-
Commands.CommandBuilder<T> |
-assertUsage(String usage,
- String failureMessage)
-Asserts that the arguments match the given usage string.
- |
-
Commands.FunctionalCommand |
-handler(Commands.CommandHandler<T> handler)
-Builds this
-Commands.CommandBuilder into a Commands.FunctionalCommand instance. |
-
default Commands.CommandBuilder<T> |
-withCooldown(Cooldown cooldown)
-Tests the command attempt against the given cooldown.
- |
-
default Commands.CommandBuilder<T> |
-withCooldown(CooldownCollection<T> cooldown)
-Tests the command attempt against the given cooldown.
- |
-
Commands.CommandBuilder<T> |
-withCooldown(CooldownCollection<T> cooldown,
- String failureMessage)
-Tests the command attempt against the given cooldown.
- |
-
Commands.CommandBuilder<T> |
-withCooldown(Cooldown cooldown,
- String failureMessage)
-Tests the command attempt against the given cooldown.
- |
-
default Commands.CommandBuilder<T> assertPermission(String permission)-
permission - the permission to check forCommands.CommandBuilder<T> assertPermission(String permission, - String failureMessage)-
permission - the permission to check forfailureMessage - the failure message to send if they don't have permissiondefault Commands.CommandBuilder<T> assertOp()-
Commands.CommandBuilder<T> assertOp(String failureMessage)-
failureMessage - the failure message to send if they're not opdefault Commands.CommandBuilder<Player> assertPlayer()-
Commands.CommandBuilder<Player> assertPlayer(String failureMessage)-
failureMessage - the failure message to send if they're not a playerdefault Commands.CommandBuilder<ConsoleCommandSender> assertConsole()-
Commands.CommandBuilder<ConsoleCommandSender> assertConsole(String failureMessage)-
failureMessage - the failure message to send if they're not consoledefault Commands.CommandBuilder<T> assertUsage(String usage)-
usage - the usage stringCommands.CommandBuilder<T> assertUsage(String usage, - String failureMessage)-
usage - the usage stringfailureMessage - the failure message to send if the arguments to not match the usagedefault Commands.CommandBuilder<T> assertArgument(int index, - Predicate<String> test)-
null is passed to the predicate.index - the index of the argument to testtest - the test predicateCommands.CommandBuilder<T> assertArgument(int index, - Predicate<String> test, - String failureMessage)-
null is passed to the predicate.
-
- "{arg}" and "{index}" will be replaced in the failure message with the index and actual argument value respectively.index - the index of the argument to testtest - the test predicatefailureMessage - the failure message to send if the predicate failsdefault Commands.CommandBuilder<T> assertSender(Predicate<T> test)-
test - the test predicateCommands.CommandBuilder<T> assertSender(Predicate<T> test, - String failureMessage)-
test - the test predicatefailureMessage - the failure message to send if the predicate failsdefault Commands.CommandBuilder<T> withCooldown(Cooldown cooldown)-
cooldown - the cooldownCommands.CommandBuilder<T> withCooldown(Cooldown cooldown, - String failureMessage)-
cooldown - the cooldownfailureMessage - the failure message to send if cooldown failsdefault Commands.CommandBuilder<T> withCooldown(CooldownCollection<T> cooldown)-
cooldown - the cooldownCommands.CommandBuilder<T> withCooldown(CooldownCollection<T> cooldown, - String failureMessage)-
cooldown - the cooldownfailureMessage - the failure message to send if cooldown failsCommands.FunctionalCommand handler(Commands.CommandHandler<T> handler)-
Commands.CommandBuilder into a Commands.FunctionalCommand instance.
-
- The command will not be registered with the server until Commands.FunctionalCommand.register(ExtendedJavaPlugin, String...) is called.handler - the command handlerCopyright © 2017. All rights reserved.
- -