This repository has been archived by the owner on Oct 30, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 22
Possible Annotation Parameters
Bastian Oppermann edited this page Apr 8, 2016
·
4 revisions
The @Command annotation supports the following parameters:
-
String[] aliases: An array with all commands which trigger the method (e.g."!info","!i", ...). Can't be empty! -
boolean requiresMention: Whether the command requires a mention (e.g.@botname info; default:true). -
boolean privateMessages: Whether the command should be allowed in private chat or not (default:true). -
boolean channelMessages: Whether the command should be allowed in channels or not (default:true). -
boolean async: Whether the command should be executed in a new thread or in the listener thread of the library (default:false). -
requiredPermissions: The required permissions for the command. A tutorial about the permissions system is comming soon™.
These parameters do not have any function itself but can be used to build your own custom help command.
-
String description: The description of the command (default:"none"). -
String usage: The usage of the command (e.g."!info [author|time]"; default:""). -
boolean showInHelpPage: Whether the command should be shown in the help page or not (default:true).