2021-01-03 07:21:15 +00:00
|
|
|
package dev.plex.command.annotation;
|
2020-10-31 04:51:22 +00:00
|
|
|
|
|
|
|
import java.lang.annotation.Retention;
|
|
|
|
import java.lang.annotation.RetentionPolicy;
|
|
|
|
|
2022-02-05 23:14:23 +00:00
|
|
|
/**
|
|
|
|
* Storage for a command's parameters
|
|
|
|
*/
|
2020-10-31 04:51:22 +00:00
|
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
|
|
public @interface CommandParameters
|
|
|
|
{
|
2022-02-05 23:14:23 +00:00
|
|
|
/**
|
|
|
|
* The name
|
2022-02-07 05:59:26 +00:00
|
|
|
*
|
2022-02-05 23:14:23 +00:00
|
|
|
* @return Name of the command
|
|
|
|
*/
|
2022-01-27 05:28:30 +00:00
|
|
|
String name();
|
|
|
|
|
2022-02-05 23:14:23 +00:00
|
|
|
/**
|
|
|
|
* The description
|
2022-02-07 05:59:26 +00:00
|
|
|
*
|
2022-02-05 23:14:23 +00:00
|
|
|
* @return Description of the command
|
|
|
|
*/
|
2020-10-31 04:51:22 +00:00
|
|
|
String description() default "";
|
2020-11-06 01:29:38 +00:00
|
|
|
|
2022-02-05 23:14:23 +00:00
|
|
|
/**
|
|
|
|
* The usage (optional)
|
2022-02-07 05:59:26 +00:00
|
|
|
*
|
2022-02-05 23:14:23 +00:00
|
|
|
* @return The usage of the command
|
|
|
|
*/
|
2020-10-31 04:51:22 +00:00
|
|
|
String usage() default "/<command>";
|
2020-11-06 01:29:38 +00:00
|
|
|
|
2022-02-05 23:14:23 +00:00
|
|
|
/**
|
|
|
|
* The aliases (optional)
|
2022-02-07 05:59:26 +00:00
|
|
|
*
|
2022-02-05 23:14:23 +00:00
|
|
|
* @return The aliases of the command
|
|
|
|
*/
|
2020-10-31 04:51:22 +00:00
|
|
|
String aliases() default "";
|
|
|
|
}
|