io.github.freya022.botcommands.api.commands.Usability.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.23

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

/**
 * Represents whether a command can be used, and if it should be visible.
 */
interface Usability {
    /**
     * All reasons this command might be unusable/invisible.
     *
     * The set is not sorted in any specific order.
     *
     * @see bestReason
     */
    val unusableReasons: Set

    /**
     * Returns `true` if the command can be executed.
     */
    val isUsable: Boolean

    /**
     * Returns `true` if the command cannot be executed.
     */
    val isNotUsable: Boolean

    /**
     * Returns `true` if the command should be visible, even if unusable (in help content, for example).
     */
    val isVisible: Boolean

    /**
     * Returns `true` if the command should **not** be visible (in help content, for example).
     */
    val isNotVisible: Boolean

    /**
     * Returns the most important un-usability reason.
     */
    val bestReason: UnusableReason

    enum class UnusableReason(
        internal val priority: Int,
        /**
         * Returns `true` if the command should be visible, even if unusable (in help content, for example).
         */
        val isVisible: Boolean,
    ) {
        HIDDEN          (priority = 4, isVisible = false),
        OWNER_ONLY      (priority = 3, isVisible = false),
        USER_PERMISSIONS(priority = 2, isVisible = false),
        BOT_PERMISSIONS (priority = 1, isVisible = true),
        NSFW_ONLY       (priority = 0, isVisible = false)
    }
}