com.freya02.botcommands.api.commands.prefixed.IHelpCommand 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 org.jetbrains.annotations.NotNull;
/**
* Interface which needs to be implemented by the help command.
*
This lets the framework use the command to also display help about specific commands
*
* You can implement a help command just like a normal command, but it has to implement this interface.
*
*
* Usage: Register your instance as a service with {@link BService}, and a {@link ServiceType} of {@link IHelpCommand}.
*/
@InterfacedService(acceptMultiple = false)
public interface IHelpCommand {
/**
* Is fired when a command is recognized, but the arguments cannot be resolved on any of the command variants.
*
*
Be aware: Localization annotations cannot be applied on this method
*
* @param event The event of the current command invocation
* @param commandInfo The command info of the command which the user tried to use
*/
void onInvalidCommand(@NotNull BaseCommandEvent event, @NotNull TextCommandInfo commandInfo);
}