Annotations
@Command
This annotation can only be used on the command class. It tells MF what command to register on. It also requires a string, which in this case will be the command name. For example for
/command.1
@Command("command")
Copied!
@Alias
This annotation will create an alias for your commands and subcommands. This can be used for both the command class and the subcommand method.
You can set one or more aliases.
1
// For one alias only.
2
@Alias("aliascommand")
3
​
4
// Multiple
5
@Alias({"firstalias", "secondalias"})
Copied!
@Default
This annotation can only be used in a method, and it's used to set a default command. This will be the command that is run without a subcommand.
For example, if you want many commands like
/command one and your help command to not have a subcommand like /command, you set it as default.1
@Default
Copied!
@SubCommand
This annotation can only be used in a method and it's used to set a subcommand.
For example, to set the command
/command one the one is the subcommand.1
@SubCommand("one")
Copied!
@Completion
This annotation can be both used on the method or on the parameter of a method.
It is used to generate a tab completion for your commands.
Examples:
1
// Let's complete the first argument with a player name and the second with a number from 1 to 20.
2
​
3
// For completion on a method
4
@Completion({"#players", "#range:1-20"})
5
public void commandTest(final CommandSender sender, final Player player, final Integer number)
6
​
7
// For completion on a parameter
8
public void commandTest(final CommandSender sender, @Completion("#players") final Player player, @Completion("#range:1-20") Integer number)
Copied!
@CompleteFor
This annotation will give you the freedom to handle the tab completion the way you want.
To use it, make a new method on your command class that returns a
List<String> then use the annotation to point it to the sub command you want to handle for.
For completing a sub command annotated with @Default use "default" as the target.
Follow the example under:1
@CompletionFor("subcommand")
2
public List<String> commandCompletion(final CommandSender commandSender, final List<String> completionArguments) {
3
// Handle the tab completion for the Sub Command "test" here.
4
​
5
return new ArrayList<>();
6
}
Copied!
@Permission
This annotation can only be used in a method and it sets the which permission node is required to run the command.
1
// Single permission
2
@Permission("plugin.command")
3
​
4
// Multiple permissions
5
@Permission({"plugin.command.one", "plugin.command.two"})
Copied!
@WrongUsage
This annotation will display the correct syntax of your command when the player types in the wrong usage.
You can use raw text in it or register a custom message using the MessageHandler and use it's
ID.
If the message ID is not registered it'll simply display the ID to the player.1
// Raw message
2
@WrongUsage("&c/cmd test <text>")
3
​
4
// Using
5
@WrongUsage("#cmd-syntax")
Copied!
@Optional
This annotation can only be used on parameters and only on the last parameter. This will make it so the last argument is optional. If the player does not type the last argument it'll return
null.
ATENTION **- Because of returning null primitive data types will not work, for example instead of int use Integer, for optional parameters only though!1
public void commandTest(final CommandSender sender, final String firstArgument, @Optional final String optionalArgument)
Copied!
@Values
This annotation will work similar to the
@Completion annotation, however it can only be used in the parameter. The difference of using Values instead of Completion is that it'll be checked and the only values allowed for that argument. For example if you set a tab completion to only have the Materials STONE and DIAMOND even if OAK_WOOD is a valid Material it'll return nullas it is not part of the tab completion.1
public void commandTest(final CommandSender sender, @Values("#some") final Material materia)
Copied!
Last modified 2mo ago