License: The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This is the main package for the CommandAPI.
This framework is built around the interface ICommand.
It is the base interface for the user to create own commands. An alternative implementation is AbstractCommand.
CommandSettings is also one of the most important classes. It is used to control the commands and their execution as well as some other features.
AbstractHelpCommand and DefaultHelpCommand belong to
the help command feature of this framework. AbstractHelpCommand provides a template for own implementations, whereas DefaultHelpCommand is the default implementation of this abstract class.
CommandEvent is a sub class of GuildMessageReceivedEvent from JDA. It is used as a parameter type in onCommand from
ICommand.
SubCommand is an annotation that is used in AbstractCommand to declare methods as sub command
methods. To see how this works, please refer to the examples or the readme file on github.
CommandSetException is a RuntimeException that is thrown in case of any problems with CommandSettings.
Please read the readme on github and take a look at the examples to see how it works.
I will give this documentation a revision in the future to provide more examples and helpful code.
| Interface | Description |
|---|---|
| ICommand |
An interface used to describe a command class.
|
| Class | Description |
|---|---|
| AbstractCommand |
This abstract class is an alternative implementation of ICommand.
|
| AbstractHelpCommand |
A template for own help command implementations.
|
| CommandEvent |
Represents a command event.
|
| CommandEvent.Command |
Describes an executed Command.
|
| CommandSettings |
To use this framework, create a new object of this class and add your command classes by using add(...)
|
| DefaultHelpCommand |
The default implementation for AbstractHelpCommand.
|
| Exception | Description |
|---|---|
| CommandSetException |
Exception that is thrown in case of any problems concerning the CommandSettings.
|
| Annotation Type | Description |
|---|---|
| SubCommand |
This annotation may be used inside of a sub class of AbstractCommand to annotate methods as SubCommand-methods.
|
Copyright © 2018. All rights reserved.