# 类的使用
org.bukkit.help.HelpTopic

使用HelpTopic的程序包
程序包
说明
org.bukkit.command.defaults
通过Bukkit实现来模拟Minecraft原生命令(1.12后所有模拟命令被删除)并提供一些其他必要的命令.
org.bukkit.help
用于操作默认的命令和主题帮助系统的类(你可以将你的命令帮助添加到系统命令帮助系统(help命令)内等等).

- ## org.bukkit.command.defaults中HelpTopic的使用

  返回HelpTopic的org.bukkit.command.defaults中的方法
  修饰符和类型
  方法
  说明
  `protected @Nullable HelpTopic`
  HelpCommand.`findPossibleMatches(@NotNull String searchString)`

- ## org.bukkit.help中HelpTopic的使用

  org.bukkit.help中HelpTopic的子类
  修饰符和类型
  类
  说明
  `class`
  `GenericCommandHelpTopic`
  Lacking an alternative, the help system will create instances of GenericCommandHelpTopic for each command in the server's CommandMap.
  `class`
  `IndexHelpTopic`
  This help topic generates a list of other help topics.
  类型参数类型为HelpTopic的org.bukkit.help中的字段
  修饰符和类型
  字段
  说明
  `protected Collection<HelpTopic>`
  IndexHelpTopic.`allTopics`
  返回HelpTopic的org.bukkit.help中的方法
  修饰符和类型
  方法
  说明
  `@Nullable HelpTopic`
  HelpTopicFactory.`createTopic(TCommand command)`
  This method accepts a command deriving from a custom command base class and constructs a custom HelpTopic for it.
  `@Nullable HelpTopic`
  HelpMap.`getHelpTopic(@NotNull String topicName)`
  获取指定主题名称的帮助主题。
  返回变量类型为HelpTopic的类型的org.bukkit.help中的方法
  修饰符和类型
  方法
  说明
  `@NotNull Collection<HelpTopic>`
  HelpMap.`getHelpTopics()`
  获得所有注册过的帮助主题集合。
  参数类型为HelpTopic的org.bukkit.help中的方法
  修饰符和类型
  方法
  说明
  `void`
  HelpMap.`addTopic(@NotNull HelpTopic topic)`
  把主题添加到服务器的帮助索引。
  `protected @NotNull String`
  IndexHelpTopic.`buildIndexLine(@NotNull CommandSender sender, @NotNull HelpTopic topic)`
  Builds individual lines in the index topic.
  `int`
  HelpTopicComparator.`compare(@NotNull HelpTopic lhs, @NotNull HelpTopic rhs)`
  类型变量类型为HelpTopic的org.bukkit.help中的方法参数
  修饰符和类型
  方法
  说明
  `protected void`
  IndexHelpTopic.`setTopicsCollection(@NotNull Collection<HelpTopic> topics)`
  Sets the contents of the internal allTopics collection.
  类型变量类型为HelpTopic的org.bukkit.help中的构造器参数
  限定符
  构造器
  说明
  ``
  `IndexHelpTopic(@NotNull String name, @Nullable String shortText, @Nullable String permission, @NotNull Collection<HelpTopic> topics)`
  ``
  `IndexHelpTopic(@NotNull String name, @Nullable String shortText, @Nullable String permission, @NotNull Collection<HelpTopic> topics, @Nullable String preamble)`