BotCommands/io.github.freya022.botcommands.api.core.config/BConfigBuilder

BConfigBuilder

class BConfigBuilder : BConfig(source)

Properties

applicationConfig

open override val applicationConfig: BApplicationConfigBuilder

classes

open override val classes: MutableSet<Class<*>>

Additional classes the framework will scan through for services, commands, handlers...

classGraphProcessors

open override val classGraphProcessors: MutableList<ClassGraphProcessor>

componentsConfig

open override val componentsConfig: BComponentsConfigBuilder

coroutineScopesConfig

open override val coroutineScopesConfig: BCoroutineScopesConfigBuilder

databaseConfig

open override val databaseConfig: BDatabaseConfigBuilder

debugConfig

open override val debugConfig: BDebugConfigBuilder

disableAutocompleteCache

@set:JvmName(name = "disableAutocompleteCache")

open override var ~~disableAutocompleteCache~~: Boolean

Disables autocomplete caching, unless CacheAutocomplete.forceCache is set to true.

disableExceptionsInDMs

@set:JvmName(name = "disableExceptionsInDMs")

open override var disableExceptionsInDMs: Boolean

Disables sending exceptions to the bot owners

ignoredEventIntents

open override val ignoredEventIntents: MutableSet<Class<out Event>>

Events for which the event waiter must ignore intent requirements.

ignoredIntents

open override val ignoredIntents: MutableSet<GatewayIntent>

Gateway intents to ignore when checking for event listeners intents.

ignoreRestRateLimiter

open override var ignoreRestRateLimiter: Boolean

Suppresses warnings about the default RestRateLimiter being used for large bots.

localizationConfig

open override val localizationConfig: BLocalizationConfigBuilder

modalsConfig

open override val modalsConfig: BModalsConfigBuilder

ownerIds

open override val ownerIds: MutableSet<Long>

User IDs of the bot owners, allowing bypassing cooldowns, user permission checks, and having hidden commands shown.

packages

open override val packages: MutableSet<String>

The packages the framework will scan through for services, commands, handlers...

predefinedOwnerIds

open override val predefinedOwnerIds: MutableSet<Long>

Predefined user IDs of the bot owners, allowing bypassing cooldowns, user permission checks, and having hidden commands shown.

serviceConfig

open override val serviceConfig: BServiceConfigBuilder

textConfig

open override val textConfig: BTextConfigBuilder

Functions

addClass

inline fun <T : Any> addClass()

fun addClass(clazz: Class<*>)

Adds a specific class containing services, commands, handlers, listeners, etc...

addOwners

fun ~~addOwners~~(vararg ownerIds: Long)

fun ~~addOwners~~(ownerIds: Collection<Long>)

Adds predefined owner IDs, disabling automatic bot owners retrieval.

addPredefinedOwners

fun addPredefinedOwners(vararg ownerIds: Long)

fun addPredefinedOwners(ownerIds: Collection<Long>)

Predefined user IDs of the bot owners, allowing bypassing cooldowns, user permission checks, and having hidden commands shown.

addSearchPath

fun addSearchPath(packageName: String)

Adds this package for class discovery. All services, commands, handlers, listeners, etc... will be read from these packages.

applicationCommands

fun applicationCommands(block: ReceiverConsumer<BApplicationConfigBuilder>)

components

fun components(block: ReceiverConsumer<BComponentsConfigBuilder>)

coroutineScopes

fun coroutineScopes(block: ReceiverConsumer<BCoroutineScopesConfigBuilder>)

database

fun database(block: ReceiverConsumer<BDatabaseConfigBuilder>)

debug

fun ~~debug~~(block: ReceiverConsumer<BDebugConfigBuilder>)

isOwner

open fun ~~isOwner~~(userId: Long): Boolean

Whether this user is one of the bot owners.

localization

fun localization(block: ReceiverConsumer<BLocalizationConfigBuilder>)

modals

fun modals(block: ReceiverConsumer<BModalsConfigBuilder>)

services

fun services(block: ReceiverConsumer<BServiceConfigBuilder>)

textCommands

fun textCommands(block: ReceiverConsumer<BTextConfigBuilder>)