io.github.freya022.botcommands.api.commands.text.HelpBuilderConsumer 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.

The newest version!

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

import io.github.freya022.botcommands.api.core.service.annotations.BService;
import io.github.freya022.botcommands.api.core.service.annotations.InterfacedService;
import net.dv8tion.jda.api.EmbedBuilder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * A consumer that's called when a help embed is about to be sent.
 * 
That embed can be for the command list as well as individual commands.
 *
 * 
 * Usage: Register your instance as a service with {@link BService}.
 *
 * @see #accept(EmbedBuilder, boolean, TextCommandInfo)
 * @see InterfacedService @InterfacedService
 */
@InterfacedService(acceptMultiple = false)
public interface HelpBuilderConsumer {
    /**
     * The function called when building a help embed
     *
     * @param builder     The {@link EmbedBuilder} to fill / override
     * @param isGlobal    {@code true} if the embed is showing all the commands,
     *                    {@code false} if the embed is for a specific command
     * @param commandInfo The text command to retrieve the help from
     *                    
Will be null if {@code isGlobal} is {@code true}
     */
    void accept(@NotNull EmbedBuilder builder, boolean isGlobal, @Nullable TextCommandInfo commandInfo);
}