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

TextCommandInfo

interface TextCommandInfo : CommandInfo(source)

Represents a text command.

Inheritors

Properties

Link copied to clipboard
abstract val aliases: List<String>

Aliases for this text command.

Link copied to clipboard
abstract val botPermissions: EnumSet<Permission>

The permissions required for the bot to run this command.

Link copied to clipboard
abstract val context: BContext

The main context.

Link copied to clipboard
abstract val declarationSite: DeclarationSite

Purely for debugging purposes, will be shown in exceptions.

Link copied to clipboard
abstract val description: String?

General description of this text command, part of the built-in help command.

Link copied to clipboard
abstract val detailedDescription: Consumer<EmbedBuilder>?

Consumer of an EmbedBuilder, runs after generating the built-in help content.

Link copied to clipboard
abstract val hidden: Boolean

Whether this command is hidden.

Link copied to clipboard
abstract val isOwnerRequired: Boolean

Whether this command can only be run by the bot owners.

Link copied to clipboard
abstract val name: String

The name of this command.

Link copied to clipboard
abstract val nsfw: Boolean

Whether this command should only be executable in NSFW channels.

Link copied to clipboard
abstract val parentInstance: INamedCommand?

The parent of this command, null for top-level commands.

Link copied to clipboard
abstract val path: CommandPath

The complete path that leads to this command.

Link copied to clipboard
abstract val subcommands: Map<String, TextCommandInfo>

Subcommands of this text command, the key is the name of the subcommand.

Link copied to clipboard
abstract val userPermissions: EnumSet<Permission>

The permissions required for the caller to use this command.

Link copied to clipboard
abstract val variations: List<TextCommandVariation>

Variations of this command, see TextCommandBuilder.variation for details.

Functions

Link copied to clipboard
abstract fun getUsability(member: Member, channel: GuildMessageChannel): Usability

Returns a Usability instance, representing whether this text command can be used, and if it is visible, for example, in the help content.

Link copied to clipboard
abstract fun hasRateLimiter(): Boolean

Return true if this has a rate limiter.