BotCommands-core/io.github.freya022.botcommands.api.core.config/BConfig

BConfig

@InjectedService

interface BConfig : IConfig, BConfigProps(source)

Properties

appEmojisConfig

abstract val appEmojisConfig: BAppEmojisConfig

applicationConfig

abstract val applicationConfig: BApplicationConfig

classes

@ConfigurationValue(path = "botcommands.core.classes", type = "java.util.Set<java.lang.Class<?>>")

abstract val classes: Set<Class<*>>

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

classGraphProcessors

abstract val classGraphProcessors: List<ClassGraphProcessor>

componentsConfig

abstract val componentsConfig: BComponentsConfig

configs

abstract val configs: Collection<IConfig>

An immutable collection of all registered configuration objects.

configType

open override val configType: Class<BConfig>

coroutineScopesConfig

abstract val coroutineScopesConfig: BCoroutineScopesConfig

databaseConfig

abstract val databaseConfig: BDatabaseConfig

disableExceptionsInDMs

@ConfigurationValue(path = "botcommands.core.disableExceptionsInDMs", defaultValue = "false")

abstract val disableExceptionsInDMs: Boolean

Disables sending exceptions to the bot owners

enableOwnerBypass

@ConfigurationValue(path = "botcommands.core.enableOwnerBypass", defaultValue = "false")

abstract val enableOwnerBypass: Boolean

Enables bot owners to bypass certain limits.

enableShutdownHook

@ConfigurationValue(path = "botcommands.core.enableShutdownHook", defaultValue = "true")

abstract val enableShutdownHook: Boolean

Whether to use a shutdown hook to call BContext.shutdownNow when the JVM is exiting gracefully.

eventManagerConfig

abstract val eventManagerConfig: BEventManagerConfig

ignoredEventIntents

@ConfigurationValue(path = "botcommands.core.ignoredEventIntents", type = "java.util.Set<java.lang.Class<net.dv8tion.jda.api.events.Event>>")

abstract val ignoredEventIntents: Set<Class<out Event>>

Events for which the event waiter must ignore intent requirements.

ignoredIntents

@ConfigurationValue(path = "botcommands.core.ignoredIntents")

abstract val ignoredIntents: Set<GatewayIntent>

Gateway intents to ignore when checking for event listeners intents.

ignoreRestRateLimiter

@ConfigurationValue(path = "botcommands.core.ignoreRestRateLimiter", defaultValue = "false")

abstract val ignoreRestRateLimiter: Boolean

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

localizationConfig

abstract val localizationConfig: BLocalizationConfig

modalsConfig

abstract val modalsConfig: BModalsConfig

packages

@ConfigurationValue(path = "botcommands.core.packages")

abstract val packages: Set<String>

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

predefinedOwnerIds

@ConfigurationValue(path = "botcommands.core.predefinedOwnerIds")

abstract val predefinedOwnerIds: Set<Long>

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

serviceConfig

abstract val serviceConfig: BServiceConfig

textConfig

abstract val textConfig: BTextConfig

Functions

getConfigOrNull

abstract fun <T : IConfig> getConfigOrNull(type: Class<T>): T?

Returns the configuration object of the provided type, or null if none were registered.

getConfigOrNull

inline fun <T : IConfig> BConfig.getConfigOrNull(): T?

fun <T : IConfig> BConfig.getConfigOrNull(type: KClass<T>): T?

Returns the configuration object of the provided type, or null if none were registered.