diff options
Diffstat (limited to 'dicore3/command/src/main/java/io/dico/dicore/command/chat/help/IHelpTopic.java')
-rw-r--r-- | dicore3/command/src/main/java/io/dico/dicore/command/chat/help/IHelpTopic.java | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/dicore3/command/src/main/java/io/dico/dicore/command/chat/help/IHelpTopic.java b/dicore3/command/src/main/java/io/dico/dicore/command/chat/help/IHelpTopic.java new file mode 100644 index 0000000..618109e --- /dev/null +++ b/dicore3/command/src/main/java/io/dico/dicore/command/chat/help/IHelpTopic.java @@ -0,0 +1,22 @@ +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 + * @return a mutable list of components to include in the help pages + */ + List<IHelpComponent> getComponents(ICommandAddress target, Permissible viewer, ExecutionContext context); + + +} |