BotCommands/io.github.freya022.botcommands.api.commands.builder/ExecutableCommandBuilder

ExecutableCommandBuilder

interface ExecutableCommandBuilder<T : OptionAggregateBuilder<T>> : CommandBuilder, OptionRegistry<T> (source)

Inheritors

Properties

Link copied to clipboard
abstract var 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 override var declarationSite: DeclarationSite

Purely for debugging purposes, will be shown in exceptions.

Link copied to clipboard
abstract val name: String

The name of this command.

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 var userPermissions: EnumSet<Permission>

The permissions required for the caller to use this command.

Functions

Link copied to clipboard
abstract fun aggregate(declaredName: String, aggregator: KFunction<*>, block: T.() -> Unit = {})

Declares multiple options aggregated in a single parameter.

Link copied to clipboard
fun CommandBuilder.cooldown(duration: Duration, scope: RateLimitScope = RateLimitScope.USER, deleteOnRefill: Boolean = true, block: RateLimitBuilder.() -> Unit = {})

Sets an anonymous rate limit-based cooldown on this command. This cooldown cannot be referenced anywhere else as it is not registered.

Link copied to clipboard
abstract fun customOption(declaredName: String)

Declares a custom option, such as an TextLocalizationContext (with @LocalizationBundle).

Link copied to clipboard
inline fun <T : OptionAggregateBuilder<T>> OptionAggregateBuilderContainer<T>.inlineClassAggregate(declaredName: String, noinline block: T.(valueName: String) -> Unit)
inline fun <T : OptionAggregateBuilder<T>> OptionAggregateBuilderContainer<T>.inlineClassAggregate(declaredName: String, noinline block: T.(valueParameter: KParameter, valueName: String) -> Unit)
inline fun <T : OptionAggregateBuilder<T>> OptionAggregateBuilderContainer<T>.inlineClassAggregate(declaredName: String, clazz: KClass<*>, crossinline block: T.(valueName: String) -> Unit)
fun <T : OptionAggregateBuilder<T>> OptionAggregateBuilderContainer<T>.inlineClassAggregate(declaredName: String, clazz: KClass<*>, block: T.(valueParameter: KParameter, valueName: String) -> Unit)

Declares an aggregate creating an instance of the specified inline class, which can only accept a single option.

Link copied to clipboard
abstract fun rateLimit(rateLimiter: RateLimiter, block: RateLimitBuilder.() -> Unit = {})

Sets an anonymous rate limiter on this command. This rate limiter cannot be referenced anywhere else as it is not registered.

Link copied to clipboard
abstract fun rateLimitReference(group: String)

Sets the rate limiter of this command to one declared by a RateLimitProvider.

Link copied to clipboard
abstract fun serviceOption(declaredName: String)

Declares a service option, allowing injection of services, which must be available.