BotCommands/io.github.freya022.botcommands.api.commands.text.annotations

Package-level declarations

Types

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class Category(val value: String)

Specifies the global category of this top-level command.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])
annotation class Hidden

Hides a command and its subcommands from help content and execution, except for bot owners.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class ID

Adapts the help content of this parameter as an ID of an entity (message, user, guild, channel, role...)

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class JDATextCommandVariation(val path: Array<out String>, val order: Int = 0, val description: String = "", val usage: String = "", val example: String = "")

Declares this function as a text command, additional properties can be set with @TextCommandData.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])
annotation class NSFW

Marks a text command as being usable in NSFW channels only.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])
annotation class RequireOwner

Marks this text command as only usable by the bot owners.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.ANNOTATION_CLASS])
@Condition(type = RequiresTextCommandsChecker::class)
@ConditionalOnProperty(value = ["botcommands.text.enable"], matchIfMissing = true)
annotation class RequiresTextCommands

Prevents usage of the annotated service if text commands are not enabled.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class TextCommandData(val path: Array<out String> = [], val aliases: Array<String> = [], val description: String = "")

Additional annotation for text commands.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class TextOption(val name: String = "", val example: String = "")

Sets a parameter as a text command option from the Discord message.