dicore3/command/src/main/java/io/dico/dicore/command/chat/help/IHelpTopic.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

package io.dico.dicore.command.chat.help;

import io.dico.dicore.command.ExecutionContext;
import io.dico.dicore.command.ICommandAddress;
import org.bukkit.permissions.Permissible;

import java.util.List;

public interface IHelpTopic {

    /**
     * Get the components of this help topic
     *
     * @param target    The address of the command to provide help about
     * @param viewer    The permissible that the page will be shown to (null -> choose a default set).
     * @param context   Context of the command execution
     * @param isForPage A boolean indicating if the components are to be used in a page (for help)
     * @return a mutable list of components to include in the help pages
     */
    List<IHelpComponent> getComponents(ICommandAddress target, Permissible viewer, ExecutionContext context, boolean isForPage);


}