[This is preliminary documentation and is subject to change.]
The CommandDescriptor type exposes the following properties.
Properties
| Member | Description | |
|---|---|---|
| Aliases | List of aliases. May be null or empty. Default: null | |
| AnyPermission | Whether any permission from the list is enough.
If this is false, ALL permissions are required. | |
| Category | Command category. Must be set before registering. | |
| ClassyName | Returns a formatted name of the command,
colored and possibly prefixed according to MinRank requried to call this command. | |
| DisableLogging | Whether calls to this command should not be logged. | |
| Handler | Callback function to execute when command is called. Must be set before registering. | |
| Help | Full text of the help message. Default: null | |
| HelpSections | Help sub-sections. | |
| IsConsoleSafe | Whether the command may be used from console. Default: false | |
| IsCustom | Whether the command is not part of fCraft core (set automatically). | |
| IsHidden | Whether the command is hidden from command list (/cmds). Default: false | |
| MinRank | Gets the lowest rank that has any/all permissions to call this command.
Returns null if none of the ranks have necessary permissions. | |
| Name | Primary command name. Must be set before registering. | |
| NotRepeatable | Whether the command should be repeated by the "/" shortcut. Default: false | |
| Permissions | List of permissions required to call the command. May be empty or null. Default: null | |
| RepeatableSelection | Whether this command involves a selection that can be repeated with /static. Default: false | |
| UsableByFrozenPlayers | Whether the command should be usable by frozen players. Default: false | |
| Usage | Brief demonstration of command's usage syntax. Defaults to "/Name". |