io.github.freya022.botcommands.api.commands.text.annotations.Hidden.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of BotCommands Show documentation

A Kotlin-first (and Java) framework that makes creating Discord bots a piece of cake, using the JDA library.

There is a newer version: 3.0.0-alpha.18

package io.github.freya022.botcommands.api.commands.text.annotations

import io.github.freya022.botcommands.api.commands.text.builder.TextCommandBuilder
import io.github.freya022.botcommands.api.core.config.BConfigBuilder

/**
 * Hides a command and its subcommands from help content and execution,
 * except for [bot owners][BConfigBuilder.ownerIds].
 *
 * **Note:** This applies to the command itself, not only this variation,
 * in other words, this applies to all commands with the same path.
 *
 * @see TextCommandBuilder.hidden DSL equivalent
 */
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
annotation class Hidden