com.freya02.botcommands.api.commands.prefixed.HelpBuilderConsumer Maven / Gradle / Ivy
package com.freya02.botcommands.api.commands.prefixed;
import com.freya02.botcommands.api.core.service.annotations.BService;
import com.freya02.botcommands.api.core.service.annotations.InterfacedService;
import com.freya02.botcommands.api.core.service.annotations.ServiceType;
import com.freya02.botcommands.internal.commands.prefixed.TextCommandInfo;
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}, and a {@link ServiceType} of {@link HelpBuilderConsumer}.
*
* @see #accept(EmbedBuilder, boolean, TextCommandInfo)
* @see 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 true if the embed is showing all the commands, false if the embed is for a specific command
* @param commandInfo The text command to retrieve the help from
*
Will be null if isGlobal is true
*/
void accept(@NotNull EmbedBuilder builder, boolean isGlobal, @Nullable TextCommandInfo commandInfo);
}