程序包 org.bukkit.help

接口 HelpTopicFactory<TCommand extends Command>

类型参数:
TCommand - 自定义命令的基类.
public interface HelpTopicFactory<TCommand extends Command>
HelpTopicFactory用于从继承自公共基类的命令或执行器继承自公共基类的执行器创建自定义HelpTopic对象. 你可以使用自定义HelpTopic来更改插件中所有命令在帮助中的显示方式. 如果你的插件实现了复杂的权限系统, 自定义帮助主题也可能很合适.

要自动将插件的命令绑定到自定义HelpTopic实现, 首先确保所有命令或执行器都派生自自定义基类(它不需要做任何事情). 接下来实现一个接受自定义命令基类并从中实例化自定义HelpTopic的HelpTopicFactory. 最后, 使用HelpMap.registerHelpTopicFactory(Class, HelpTopicFactory)方法将HelpTopicFactory注册到命令基类.

当帮助系统遍历所有注册的命令以创建帮助主题时, 它首先检查是否有为该命令基类注册的HelpTopicFactory. 如果有, 则使用工厂创建帮助主题而不是通用帮助主题. 如果没有找到工厂且命令派生自PluginCommand, 则会检查命令执行器的类型以查找注册的HelpTopicFactory. 最后, 如果没有找到工厂, 则为该命令创建通用帮助主题.

  • 方法概要

    修饰符和类型
    方法
    说明
    @Nullable HelpTopic
    createTopic(TCommand command)
    此方法接受派生自自定义命令基类的命令并为其构建自定义HelpTopic.

  • 方法详细资料

    • createTopic

      @Nullable @Nullable HelpTopic createTopic(@NotNull TCommand command)
      此方法接受派生自自定义命令基类的命令并为其构建自定义HelpTopic.

      原文： This method accepts a command deriving from a custom command base class and constructs a custom HelpTopic for it.

      参数:
      command - 要为其构建帮助主题的自定义命令.
      返回:
      一个新的自定义帮助主题, 或null表示故意不创建主题.